VORIM
We use cookies

We use cookies to analyze site traffic and improve your experience. You can choose to accept all cookies or only essential ones. See our Privacy Policy.

Vorim CLI

Run Vorim from the terminal. One init command gets you from an empty project to a registered agent with a checked permission in about sixty seconds.

CLI Tool

The @vorim/cli scaffolds projects, registers agents, and manages identity directly from the terminal. Get to "first agent secured" in 60 seconds.

npm

Installation

# Run directly (no install needed)
npx @vorim/cli init

# Or install globally
npm install -g @vorim/cli
bash

Initialize a Project

Scaffolds a Vorim-enabled project: tests connection, registers your first agent, emits a test event, and creates vorim.json + .env.

$ npx @vorim/cli init

  ╔══════════════════════════════╗
  ║        VORIM AI CLI        ║
  ║  Agent Identity & Trust Layer ║
  ╚══════════════════════════════╝

→ Setting up Vorim AI in this project
✓ Found API key: agid_sk_live_abc...
→ Testing connection...
✓ Connected to Vorim AI (healthy)
API Key: agid_sk_live_abc...
Project name (my-project): my-project
First agent name (my-project-agent): my-project-agent
→ Registering agent "my-project-agent"...
✓ Agent registered: agid_org_a1b2c3d4
✓ Granted agent:read permission
✓ First audit event emitted
✓ Created vorim.json
✓ Added Vorim keys to .env
bash

Commands

CommandDescription
vorim initScaffold a new project, register first agent, create config files
vorim register [name]Register a new agent with a cryptographic identity
vorim verify <agent-id>Check an agent's trust score and status
vorim statusCheck API health, connection, and project config
vorim agentsList all agents with status and trust scores
vorim grant <id> <scope>Grant a permission scope to an agent
vorim check <id> <scope>Check if an agent has a specific permission
vorim emit <id> <action>Emit an audit event for an agent action

Configuration

The CLI looks for your API key in this order:

# 1. Environment variable
export VORIM_API_KEY=agid_sk_live_...

# 2. .env file in current directory
VORIM_API_KEY=agid_sk_live_...

# 3. vorim.json in current directory (created by vorim init)
{ "apiKey": "agid_sk_live_..." }
typescript
Need Help?

Book a demo for a walkthrough, or contact us for support. For enterprise needs, reach out at sales@vorim.ai.