Installation

System requirements

Component	Minimum version
Node.js	18.x or later
npm	9.x or later
OS	macOS, Linux, Windows (WSL2 recommended)

---

Install the CLI

npm

npm install -g @orvanta/cli

pnpm

pnpm add -g @orvanta/cli

yarn

yarn global add @orvanta/cli

Verify the installation:

orvanta --version

---

Connect to a workspace

Authenticate by adding a workspace profile. Create a token first from the Orvanta UI under User Settings → Tokens (or run orvanta user create-token), then:

orvanta workspace add

This walks you through adding a profile, a (name, remote URL, workspace id, token) tuple stored under your config directory (default ~/.config, override with OV_CONFIG_DIR). You can keep several profiles and switch with orvanta workspace switch <name>.

For a self-hosted instance, point the remote at your own URL (e.g. https://orvanta.example.com).

---

Updating

orvanta upgrade

---

Next steps

• Quick Start: Create and run your first workflow.
• CLI Reference: Commands and the sync-based workflow.