@vorim/cli

Manage AI agent identities from the terminal.

Scaffold projects, register agents, verify trust scores, grant permissions, and emit audit events — all from the command line.

vorim.ai — Create a free account and get your API key in 30 seconds. Documentation — Full API reference and guides.

Install

npm install -g @vorim/cli

Or run directly with npx:

npx @vorim/cli

Quick Start

# 1. Set up Vorim in your project (registers your first agent)
npx @vorim/cli init

# 2. Check your agent's trust score
npx @vorim/cli verify <agent-id>

# 3. List all agents
npx @vorim/cli agents

Commands

| Command | Description | |---------|-------------| | vorim init | Scaffold a new Vorim-enabled project — connects to the API, registers an agent, creates vorim.json and .env | | vorim register [name] | Register a new agent (Ed25519 keypair generated, private key shown once) | | vorim verify <agent-id> | Check an agent's trust score and verification factors | | vorim status | Check API health, connection, and project config | | vorim agents | List all agents in your organisation | | 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 | | vorim help | Show help | | vorim version | Show version |

Environment Variables

| Variable | Description | Default | |----------|-------------|---------| | VORIM_API_KEY | Your Vorim API key (agid_sk_...) | — | | VORIM_BASE_URL | API base URL | https://vorim.ai/v1 |

The CLI also reads from .env files and vorim.json in your project directory.

Examples

Initialize a project

$ npx @vorim/cli init

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

→ Setting up Vorim AI in this project
✓ Connected to Vorim AI (ok)
✓ Agent registered: agid_acme_a1b2c3d4
✓ Granted agent:read permission
✓ Created vorim.json
✓ Created .env

Verify an agent

$ npx @vorim/cli verify agid_acme_a1b2c3d4

✓ Trust verification complete

  Agent:       agid_acme_a1b2c3d4
  Trust Score: 85/100
  Status:      active
  Factors:
    Status:      20
    Age:         15
    Success:     25
    Denials:     15
    Scope:       10

Grant and check permissions

$ npx @vorim/cli grant agid_acme_a1b2c3d4 agent:execute
✓ Permission granted: agent:execute

$ npx @vorim/cli check agid_acme_a1b2c3d4 agent:execute
✓ ALLOWED — agent has agent:execute permission

Emit an audit event

$ npx @vorim/cli emit agid_acme_a1b2c3d4 search_documents
✓ Audit event emitted: search_documents

How It Works

The CLI uses the @vorim/sdk under the hood. Everything the CLI does, you can also do programmatically:

import createVorim from "@vorim/sdk";

const vorim = createVorim({ apiKey: "agid_sk_live_..." });

const { agent } = await vorim.register({ name: "my-agent", capabilities: ["search"], scopes: ["agent:read"] });
const trust = await vorim.verify(agent.agent_id);

Related

• @vorim/sdk — TypeScript SDK
• vorim (PyPI) — Python SDK
• @vorim/mcp-server — MCP server for Claude, Cursor, and VS Code
• vorim.ai/docs — Documentation

License

MIT