cobra: github.com/spf13/cobra/doc Index | Examples | Files

package doc

import "github.com/spf13/cobra/doc"

Index

Examples

Package Files

man_docs.go md_docs.go rest_docs.go util.go yaml_docs.go

func GenMan Uses

func GenMan(cmd *cobra.Command, header *GenManHeader, w io.Writer) error

GenMan will generate a man page for the given command and write it to w. The header argument may be nil, however obviously w may not.

Code:

cmd := &cobra.Command{
    Use:   "test",
    Short: "my test program",
}
header := &doc.GenManHeader{
    Title:   "MINE",
    Section: "3",
}
out := new(bytes.Buffer)
doc.GenMan(cmd, header, out)
fmt.Print(out.String())

func GenManTree Uses

func GenManTree(cmd *cobra.Command, header *GenManHeader, dir string) error

GenManTree will generate a man page for this command and all descendants in the directory given. The header may be nil. This function may not work correctly if your command names have `-` in them. If you have `cmd` with two subcmds, `sub` and `sub-third`, and `sub` has a subcommand called `third` it is undefined which help output will be in the file `cmd-sub-third.1`.

Code:

cmd := &cobra.Command{
    Use:   "test",
    Short: "my test program",
}
header := &doc.GenManHeader{
    Title:   "MINE",
    Section: "3",
}
doc.GenManTree(cmd, header, "/tmp")

func GenManTreeFromOpts Uses

func GenManTreeFromOpts(cmd *cobra.Command, opts GenManTreeOptions) error

GenManTreeFromOpts generates a man page for the command and all descendants. The pages are written to the opts.Path directory.

func GenMarkdown Uses

func GenMarkdown(cmd *cobra.Command, w io.Writer) error

GenMarkdown creates markdown output.

func GenMarkdownCustom Uses

func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error

GenMarkdownCustom creates custom markdown output.

func GenMarkdownTree Uses

func GenMarkdownTree(cmd *cobra.Command, dir string) error

GenMarkdownTree will generate a markdown page for this command and all descendants in the directory given. The header may be nil. This function may not work correctly if your command names have `-` in them. If you have `cmd` with two subcmds, `sub` and `sub-third`, and `sub` has a subcommand called `third`, it is undefined which help output will be in the file `cmd-sub-third.1`.

func GenMarkdownTreeCustom Uses

func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error

GenMarkdownTreeCustom is the the same as GenMarkdownTree, but with custom filePrepender and linkHandler.

func GenReST Uses

func GenReST(cmd *cobra.Command, w io.Writer) error

GenReST creates reStructured Text output.

func GenReSTCustom Uses

func GenReSTCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string, string) string) error

GenReSTCustom creates custom reStructured Text output.

func GenReSTTree Uses

func GenReSTTree(cmd *cobra.Command, dir string) error

GenReSTTree will generate a ReST page for this command and all descendants in the directory given. This function may not work correctly if your command names have `-` in them. If you have `cmd` with two subcmds, `sub` and `sub-third`, and `sub` has a subcommand called `third`, it is undefined which help output will be in the file `cmd-sub-third.1`.

func GenReSTTreeCustom Uses

func GenReSTTreeCustom(cmd *cobra.Command, dir string, filePrepender func(string) string, linkHandler func(string, string) string) error

GenReSTTreeCustom is the the same as GenReSTTree, but with custom filePrepender and linkHandler.

func GenYaml Uses

func GenYaml(cmd *cobra.Command, w io.Writer) error

GenYaml creates yaml output.

func GenYamlCustom Uses

func GenYamlCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error

GenYamlCustom creates custom yaml output.

func GenYamlTree Uses

func GenYamlTree(cmd *cobra.Command, dir string) error

GenYamlTree creates yaml structured ref files for this command and all descendants in the directory given. This function may not work correctly if your command names have `-` in them. If you have `cmd` with two subcmds, `sub` and `sub-third`, and `sub` has a subcommand called `third` it is undefined which help output will be in the file `cmd-sub-third.1`.

func GenYamlTreeCustom Uses

func GenYamlTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error

GenYamlTreeCustom creates yaml structured ref files.

type GenManHeader Uses

type GenManHeader struct {
    Title   string
    Section string
    Date    *time.Time

    Source string
    Manual string
    // contains filtered or unexported fields
}

GenManHeader is a lot like the .TH header at the start of man pages. These include the title, section, date, source, and manual. We will use the current time if Date is unset and will use "Auto generated by spf13/cobra" if the Source is unset.

type GenManTreeOptions Uses

type GenManTreeOptions struct {
    Header           *GenManHeader
    Path             string
    CommandSeparator string
}

GenManTreeOptions is the options for generating the man pages. Used only in GenManTreeFromOpts.

Package doc imports 13 packages (graph) and is imported by 702 packages. Updated 2019-12-02. Refresh now. Tools for package owners.