help
Explain a topic that is not a command.
read onlyrepeatableno sign-in
Explain a topic that is not a command.
Usage
outplane help [TOPIC]Arguments
| Argument | Type | Description |
|---|---|---|
TOPIC | string | Which topic to print. Omit to list the topics. |
Examples
List the topics
outplane helpRead the exit code contract
outplane help exit-codesRead the shape of a failure
outplane help errorsWhat to Know
- These topics are prose for a person. The same facts are in
outplane schemaas data, under errorKinds and each command's exitCodes, and that is what a program should read.
Errors
Beyond 0 for success, this command exits with:
| Exit | Kind | Meaning |
|---|---|---|
2 | usage | Invalid arguments, unknown flag, or client-side validation failure. |
The code on the error object is one of usage.unknown_topic. Branch on that, or on the exit status. The message is prose and changes.