CLI Overview
The Orvanta CLI (orvanta) is the primary command-line interface for interacting with your Orvanta instance. It lets you manage workflows, scripts, and runs from any terminal.
Installation
Section titled “Installation”See Installation for full setup instructions.
orvanta <command> [subcommand] [options]Global options
Section titled “Global options”| Flag | Description |
|---|---|
--url <url> | Override the Orvanta instance URL (default: https://api.orvanta.cloud). |
--token <token> | Provide a token directly instead of using the stored credential. |
--json | Output responses as JSON (useful for scripting). |
--no-color | Disable coloured output. |
--quiet | Suppress all output except errors. |
--help | Show help for any command. |
--version | Print the CLI version. |
Commands
Section titled “Commands”| Command | Description |
|---|---|
login | Authenticate with an Orvanta instance. |
workflows | Create, list, and manage workflows. |
scripts | Create, publish, and manage scripts. |
runs | Trigger, list, and inspect workflow runs. |
Configuration
Section titled “Configuration”The CLI stores its configuration in ~/.orvanta/:
| File | Contents |
|---|---|
credentials | Authentication token and instance URL. |
config.json | User preferences (default output format, etc.). |
You can switch between multiple instances by setting the ORVANTA_URL and ORVANTA_TOKEN environment variables, which take precedence over stored credentials.
ORVANTA_URL=https://staging.example.com ORVANTA_TOKEN=<token> orvanta runs list