fsoc gendocs

Generate docs for fsoc

Synopsis

Generates markdown documentation for the fsoc command and their usage. It will generate a series of files, one for each command; root and sub-root commands include relative hyperlinks to individual commands. The directory should either be empty or not exist.

fsoc gendocs PATH [flags]

Examples

  fsoc gendocs /tmp/docs

Options

      --h1          adjust generated headings to start from h1 rather than h2 (default true)
  -h, --help        help for gendocs
      --rel-links   adjust generated platform doc links to become relative (default true)

Options Inherited From Parent Commands

      --config string      config file (default is ~/.fsoc). May be .yaml or .json
      --curl               log curl equivalent for platform API calls (implies --verbose)
      --fields string      perform specified fields transform/extract JQ expression
      --log string         set a location and name for the fsoc log file (default "/tmp/fsoc.log")
      --no-version-check   skip the daily check for new versions of fsoc
  -o, --output string      output format (auto, table, detail, json, yaml) (default "auto")
      --profile string     access profile (default is current or "default")
  -v, --verbose            enable detailed output

See Also

• fsoc - fsoc - Cisco Observability Platform Control Tool