Skip to main content

furyctl dump cli-reference

Exports the CLI reference in markdown format into a specified folder in the working directory

Synopsis​

Exports the CLI reference in markdown format into a specified folder in the working directory. The folder will be created if it does not exist.

Usage​

furyctl dump cli-reference [folder] [flags]

Examples​

furyctl dump cli-reference ./docs/cli-reference

Options​

  -h, --help             help for cli-reference
      --no-overwrite     Do not overwrite existing files. Will exit if the output folder already exists. WARNING: setting this to false will delete the folder and its content. (default true)
  -w, --workdir string   Working directory to use for the output folder. Default is the current working directory

Options inherited from parent commands​

  -D, --debug                 Enables furyctl debug output. This will greatly increase the verbosity. Notice that you can always access the debug output in the log file.
  -d, --disable-analytics     Disable analytics
  -g, --git-protocol string   Download repositories using the given protocol (options: https, ssh). Use when SSH traffic is being blocked or when SSH client has not been configured
                              set the GITHUB_TOKEN environment variable with your token to use authentication while downloading, for example for private repositories (default "https")
  -H, --https                 DEPRECATED: by default furyctl uses https protocol to download repositories (default true)
  -l, --log string            Path to the log file or set to 'stdout' to log to standard output. Default is '<outdir>/.furyctl/furyctl.<timestamp>-<random number>.log'
  -T, --no-tty                Disable TTY making furyctl's output more friendly to non-interactive shells by disabling animations and colors
  -o, --outdir string         Path where to create the data directory (.furyctl). Default is the user's home.

See Also​

  • furyctl dump - Dump rendered templates or other useful objects to the filesystem