schema
Print the machine-readable description of every command.
read onlyrepeatableno sign-in
Print the machine-readable description of every command.
Usage
outplane schema [COMMAND]Arguments
| Argument | Type | Description |
|---|---|---|
COMMAND | string | Command path, such as deploy create. Omit for the whole surface. |
Output
| Field | Type | Description |
|---|---|---|
schemaVersion | string | The shape of this document, not the CLI version. |
version | string | The CLI that produced it, or unstamped for a local build. |
commands | array | One object per command. |
globalArgs | array | Flags every command accepts. |
errorKinds | array | Error kind, its exit code, and whether a retry can help. |
riskLevels | array | What read, write and destructive mean here. |
Examples
Read the whole surface
outplane schemaRead one command instead of all of them
outplane schema deploy createList the commands that only read
outplane schema --json --fields commands | jq -r '.commands[] | select(.risk == "read") | .name'What to Know
- Output is JSON whether or not a terminal is attached, because there is no human rendering of this document.
- version reads
unstampedon a build that was not made from a release tag. Treat that as unknown rather than as old. - A single command still carries globalArgs, errorKinds and riskLevels, so one fetch is enough to know how to call it and how to read its failure.
Errors
Beyond 0 for success, this command exits with:
| Exit | Kind | Meaning |
|---|---|---|
2 | usage | Invalid arguments, unknown flag, or client-side validation failure. |
5 | not_found | The named resource does not exist, or is not visible to this credential. |
The code on the error object is one of usage.unknown_command. Branch on that, or on the exit status. The message is prose and changes.