Oko/Docs

Command reference

oko requirements

Dispatches the requirements command group.

Invocation#

Command
oko requirements <subcommand> [options]

Inputs and options#

  • Subcommand: read, take, submit, release, status, coverage, list, show, find, embedder.
  • Each leaf page documents its accepted inputs and options.
  • --json, on any oko command, is always accepted and prints the answer as JSON; --plain prints the same answer as indented key: value lines for a person instead and is taken out before the command reads its flags.

Output and state effect#

  • Delegates to the selected leaf command; the group itself does not mutate state.

Refusals and safe exits#

  • An unknown subcommand is refused with the subcommands the group takes and exit status 2, the status every oko usage error exits with; other refusals exit 1.
  • A leaf that acts on one <id> refuses a second positional word with exit status 2 — `oko <group> <leaf> acts on one <id>; it was also given <word>, which it would not read` — instead of acting on the first and dropping the rest. Leaves that take several ids, such as `oko defects show`, say so in their invocation.
  • A leaf whose invocation names only flags (`oko defects list`, `oko rulings list|record|repeats`, `oko calendar add|edit|remove`, `oko api status|call`, `oko release surface|baseline`) refuses a bare word with exit status 2 — `<command> takes only flags; it was given <word>, which it would not read` — so `oko defects list stado` is refused instead of listing every product; filter with `--product stado`.
  • A flag that takes no value (a switch, such as `--open`, `--unowned` or `--json`) means the same on every oko command and never takes the word after it: that word is a positional word, so `oko defects list --open stado` is refused as above instead of reading `stado` as the switch's value and listing every product.

CLI reference#