cmd-doc

cmd-doc - A simple tool to generate markdown from command help, currently supports format like urfave/cli.

NOTE: The following documentation has been auto-generated by the command itself.

cmd-doc

generates markdown from commands

name: cmd-doc version: v0.0.0

This command is a utility to allow automated documentation of binaries.

Output will be printed to stdout in markdown format, and may be processed further, from there.

NAME:
   cmd-doc - generates markdown from commands

USAGE:
   cmd-doc [global options] command [command options] [arguments...]

VERSION:
   v0.0.0

DESCRIPTION:
   This command is a utility to allow automated documentation of binaries.

   Output will be printed to stdout in markdown format, and may be processed
   further, from there.

COMMANDS:
     urfave   outputs markdown from a golang command based on the urfave/cli package
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --header value  prepends to output as-is (no extra newline)
   --footer value  appends to output as-is (no extra newline)
   --help, -h      show help
   --version, -v   print the version

cmd-doc urfave

outputs markdown from a golang command based on the urfave/cli package

name: cmd-doc urfave

This command can be used to generate documentation from commands using the golang github.com/urfave/cli package, such as this one.

Note that the command may be from anything runnable in the require format, including a dockerised binary.

NAME:
   cmd-doc urfave - outputs markdown from a golang command based on the urfave/cli package

USAGE:
   cmd-doc urfave [--] COMMAND [...ARGS]

DESCRIPTION:
   This command can be used to generate documentation from commands using
   the golang github.com/urfave/cli package, such as this one.

   Note that the command may be from anything runnable in the require format,
   including a dockerised binary.