CLI
canyon is the CLI for the New Orchestrator.
Installation
The CLI binary is part of the release package that is distributed during Alpha testing. Public builds and associated installation instructions will be published here once available.
CLI cheat sheet
An overview of common and useful CLI commands is available in the CLI cheat sheet.
Configuration
canyon will maintain a local configuration in a config file located at ~/.config/canyon/config.yaml. Use the command canyon config or the list below to see available configuration items.
Each configuration item can be overridden using an Environment Variable.
The command canyon config show displays the effective configuration, taking any override into account.
| Config item | Environment variable | CLI command | Description | Default | Mandatory |
|---|---|---|---|---|---|
default_org_id |
CANYON_ORG |
canyon config set-org |
The id of the Organization in which to run commands | "" | Yes |
api_url |
CANYON_API_URL |
canyon config set-url |
The base URL of the Orchestrator API | "" | Yes |
Commands
canyon follows a hierarchical command structure generally adhering to this pattern:
canyon <verb> <object> [additional classification]
E.g. to see the details of a particular Provider, use this command:
canyon get provider <type> <id>
All available commands are listed and explained in the CLI online help. Use the -h or --help flag to see usage details on any command level, e.g.:
canyon get provider -h