Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ConsoleCmd = &cobra.Command{
Use: "console",
Short: "infomark console commands",
}
ConsoleCmd starts the infomark console
View Source
var RootCmd = &cobra.Command{
Use: "infomark",
Short: "A CI based course framework",
Long: `InfoMark is a a scalable, modern and open-source
online course management system supporting auto-testing/grading of
programming assignments and distributing exercise sheets.
The infomark-server is the REST api backend for the course distributing system.
Complete documentation is available at https://infomark.org/.
`,
}
RootCmd represents the base command when called without any subcommands
View Source
var UtilsCmd = &cobra.Command{
Use: "utils",
Short: "Some helper functions.",
}
View Source
var UtilsCompletionCmd = &cobra.Command{ Use: "completion [shell]", Short: "Output (bash/zsh) shell completion code", Long: `Pipe the stdout to your completion collection, e.g., ./infomark console utils completion zsh > ~/.my-shell/completions/_infomark `, Run: func(cmd *cobra.Command, args []string) { if len(args) != 1 { log.Fatalln("Expected one argument with the desired shell") } switch args[0] { case "bash": RootCmd.GenBashCompletion(os.Stdout) case "zsh": RootCmd.GenZshCompletion(os.Stdout) default: log.Fatalf("Unknown shell %s, only bash and zsh are available\n", args[0]) } }, }
View Source
var UtilsDocCmd = &cobra.Command{ Use: "doc", Short: "Generates docs for console", Run: func(cmd *cobra.Command, args []string) { if len(args) != 1 { log.Fatalln("Expected one argument with the destination dir") } const fmTemplate = `--- date: %s title: "%s" slug: %s url: %s lastmod: %s layout: subpagewithout --- ` filePrepender := func(filename string) string { now := time.Now().Format(time.RFC3339) name := filepath.Base(filename) base := strings.TrimSuffix(name, path.Ext(name)) url := "/guides/console/commands/" + strings.ToLower(base) + "/" return fmt.Sprintf(fmTemplate, now, "Console", base, url, now) } linkHandler := func(name string) string { base := strings.TrimSuffix(name, path.Ext(name)) return "/guides/console/commands/" + strings.ToLower(base) + "/" } err := doc.GenMarkdownTreeCustom(RootCmd, args[0], filePrepender, linkHandler) if err != nil { log.Fatal(err) } }, }
Functions ¶
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.