CLI Overview

The Orvanta CLI (orvanta) is the primary command-line interface for managing scripts, flows, apps, and other resources in a workspace. It works on a local-files-synced-to-workspace model: you keep scripts and flows as files in a git repository, then push and pull changes to a workspace.

Canonical reference

This section is a guided introduction. The complete, always-current command reference is auto-generated from the platform on every release:

• GitHub: orvanta-cloud/orvanta-cli-docs
• For AI editors (Context7): context7.com/orvanta-cloud/orvanta-cli-docs: indexed for LLMs and AI coding assistants (Claude Code, Cursor, Copilot, …).

You can also search the docs from your terminal with orvanta docs <query>.

Installation

See Installation for full setup instructions.

npm install -g @orvanta/cli
orvanta --version

Upgrade later with orvanta upgrade.

Usage

orvanta <command> [subcommand] [options]

The core loop

orvanta workspace add     # connect to a workspace (creates a profile)
orvanta init              # initialise a project directory + sync config
orvanta sync pull         # bring remote scripts/flows/apps into local files
# ... edit files ...
orvanta sync push         # deploy local changes back to the workspace

Command groups

Group	Description
workspace	Add, switch, and manage workspace profiles.
sync	Push and pull changes between local files and a workspace.
script	Create, run, and manage scripts.
flow	Create, run, and manage flows.
job	List, inspect, and cancel jobs.
app	Create and develop apps (app new, app dev).
resource / variable / schedule / trigger	Manage workspace resources.

Global options

Flag	Description
--workspace <name>	Target a specific workspace, overriding the default.
--token <token>	Provide an API token directly (overrides any stored token).
--base-url <url>	Target a specific instance URL (requires --token and --workspace).
--config-dir <dir>	Use a custom config directory (overrides OV_CONFIG_DIR and the default ~/.config).
--debug --verbose	Show debug/verbose logs.
--json	Output as JSON (useful for piping to jq).

Configuration

Workspace profiles, each a (name, remote URL, workspace id, token) tuple, are stored under your Orvanta config directory (default ~/.config, override with OV_CONFIG_DIR). Switch between profiles with orvanta workspace switch <name>.