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. Debug logs and additional logs are also always written to the log file. See the --log flag.
  -d, --disable-analytics           Disable analytics
  -g, --git-protocol git-protocol   Download repositories using the given protocol. 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. 
                                    Options are: ssh, https (default https)
  -H, --https                       DEPRECATED: by default furyctl uses https protocol to download repositories. See --git-protocol flag (default true)
  -l, --log string                  Path to a file or folder where to write logs to. Set to 'stdout' write to standard output. Target path will be created if it does not exists. Path is relative to --workdir. 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 ".furyctl" data directory. Default is the user's home. Path is relative to --workdir

See Also​

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