Skip to main content
The Verial CLI ships with the @verial-ai/sdk npm package. Install it globally, install per-project, or run on demand via npx.

Global install

npm install -g @verial-ai/sdk
After installation, the verial binary is on your PATH:
verial --version

Per-project install

npm install @verial-ai/sdk
Run via npx:
npx verial --version

Run without installing

npx --yes @verial-ai/sdk --version

Authenticate

Set your organization API key as an environment variable:
export VERIAL_API_KEY=vk_xxx
Or pass --api-key on every invocation:
verial --api-key vk_xxx <command>
See Authentication for key creation, rotation, and Solver key handling.

Verify

verial environments list
If the CLI can reach the API with your key, this returns a list of environments (or an empty list for a fresh organization).

Next Steps

Overview

Command surface and output modes.

Authentication

API key and Solver key flows.