Skip to content

cmdgraph

Live filter for command sections and the page index.

Showing all commands.

Dark mode

cmdgraph

1 child command

Usage

$ cmdgraph [COMMAND]

Subcommands

  • generate

cmdgraph generate

ARGUMENTS

12 options

Usage

$ cmdgraph generate COMMAND [--max-depth <value>] [--format json|md|html|llms-txt|sitemap...] [--output <value>] [--timeout <value>] [--concurrency <value>] [--parser <value>] [--output-root-command-name <value>] [--output-html-title <value>] [--output-html-project-link <value>] [--output-html-readme <value>] [--output-llms-txt-base-url <value>] [--output-sitemap-base-url <value>]

Examples

$ cmdgraph generate kubectl --output=./docs

Options

  • --concurrency=<value>

    [default: 4] Maximum number of help commands to run in

  • --max-depth=<value>

    Limit recursion depth

  • --parser=<value>

    Force parser plugin name

  • --timeout=<value>

    [default: 5000] Per-command execution timeout in

  • --format=<option>...

    [default: json] Output format; repeat the

  • --output=<value>

    [default: ./docs] Output directory

  • --output-root-command-name=<value>

    Override displayed root command name in

  • --output-html-project-link=<value>

    Project URL shown in the HTML footer

  • --output-html-readme=<value>

    Path to a .md file rendered as a README

  • --output-html-title=<value>

    Custom HTML page title

  • --output-llms-txt-base-url=<value>

    Base site URL used for llms.txt links

  • --output-sitemap-base-url=<value>

    Base site URL used for sitemap.xml links

Arguments

  • COMMAND
  • --max-depth <value>
  • --format json|md|html|llms-txt|sitemap...
  • --output <value>
  • --timeout <value>
  • --concurrency <value>
  • --parser <value>
  • --output-root-command-name <value>
  • --output-html-title <value>
  • --output-html-project-link <value>
  • --output-html-readme <value>
  • --output-llms-txt-base-url <value>
  • --output-sitemap-base-url <value>