Installation
System requirements
Section titled “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
Section titled “Install the CLI”npm install -g @orvanta/clipnpm add -g @orvanta/cliyarn global add @orvanta/cliVerify the installation:
orvanta --versionConnect to your instance
Section titled “Connect to your instance”Orvanta Cloud
Section titled “Orvanta Cloud”orvanta loginThis opens a browser window for OAuth authentication against orvanta.cloud. Your session token is stored at ~/.orvanta/credentials.
Self-hosted instance
Section titled “Self-hosted instance”orvanta login --url https://your-orvanta-instance.example.comUpdating
Section titled “Updating”npm update -g @orvanta/cliUninstalling
Section titled “Uninstalling”npm uninstall -g @orvanta/cliYour credentials and local config at ~/.orvanta/ are not removed automatically. Delete that directory manually if you want a clean uninstall.
Next steps
Section titled “Next steps”- Quick Start — Run your first workflow.
- CLI Reference — Full command reference.