Skip to content
Nodus

nodus explain

View Markdown

nodus explain

Section titled “nodus explain”

Show the documentation of a kind or one of its fields

nodus explain KIND[.FIELD...] [flags]

Examples

Section titled “Examples”
  nodus explain jobs
  nodus explain job.spec.resources.gpu
  nodus explain sandbox.spec --recursive

Options

Section titled “Options”
  -h, --help            help for explain
  -o, --output string   Output format: plaintext or plaintext-openapiv2 (default "plaintext")
      --recursive       Print every nested field

Options inherited from parent commands

Section titled “Options inherited from parent commands”
      --context string   Context from the config file to use
      --org string       Organization (selects the context for that org)
  -p, --project string   Project to work in
  -v, --verbose          Log each API request (never credentials)

SEE ALSO

Section titled “SEE ALSO”
  • nodus - Run compute Jobs on Nodus

Tested examples

Section titled “Tested examples”

These invocations run in CI against the CLI’s fake API.

Terminal window
nodus explain jobs
nodus explain job.spec.maxCostUSD