Skip to content

Fox docs

fox docs

Generate docs for 🦊 Fox

Synopsis

Run this command to automatically generate 🦊 Fox documentation. Output is placed in the subdirectory docs of the working directory.

fox docs [flags]

Options

  -h, --help   help for docs

Options inherited from parent commands

  -a, --app string                 path to directory containing KubeFox App
  -i, --info                       enable info output
  -o, --output string              output format, one of ["json", "yaml"] (default "yaml")
      --registry-address string    address of your container registry
      --registry-token string      access token for your container registry
      --registry-username string   username for your container registry
  -m, --timeout duration           timeout for command (default 5m0s)
  -v, --verbose                    enable verbose output

SEE ALSO

  • fox - CLI for interacting with KubeFox