Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 1.53 KB

metal_emdocs.md

File metadata and controls

44 lines (31 loc) · 1.53 KB
Raw

metal emdocs

Generates single-page reference documentation.

Synopsis

Generates single-page reference documentation with filename emdocs.md in the specified directory.

metal emdocs <destination>

Examples

  # Generate emdocs.md in the ./docs directory:
  metal emdocs ./docs

Options

  -h, --help   help for emdocs

Options inherited from parent commands

      --config string         Path to JSON or YAML configuration file (METAL_CONFIG)
      --exclude strings       Comma separated Href references to collapse in results, may be dotted three levels deep
      --filter stringArray    Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
      --http-header strings   Headers to add to requests (in format key=value)
      --include strings       Comma separated Href references to expand in results, may be dotted three levels deep
  -o, --output string         Output format (*table, json, yaml). env output formats are (*sh, terraform, capp).
      --search string         Search keyword for use in 'get' actions. Search is not supported by all resources.
      --sort-by string        Sort fields for use in 'get' actions. Sort is not supported by all resources.
      --sort-dir string       Sort field direction for use in 'get' actions. Sort is not supported by all resources.
      --token string          Metal API Token (METAL_AUTH_TOKEN)

SEE ALSO

  • metal - Command line interface for Equinix Metal