Installation — Opacus Docs

Option 1: Cloud (Zero Install)

The fastest way to use Opacus. No local binaries required.

Agentboard: Use agentboard.html to activate agents and fund your Kinetic Ledger.
Cloud API: Connect to https://api.opacus.xyz using your API keys from the Settings tab.

Option 2: Kinetic MCP (Local AI Bridge)

To use Opacus agents inside Claude Desktop, Cursor, or any MCP-compatible IDE.

Install Node.js

Ensure you have Node.js 18+ installed on your machine.

Install the bridge

npm install -g @opacus/kinetic-mcp

Configure IDE

Add the following to your claude_desktop_config.json:

{
  "mcpServers": {
    "opacus": {
      "command": "npx",
      "args": ["-y", "@opacus/kinetic-mcp"],
      "env": { "OPACUS_API_KEY": "your_key_here" }
    }
  }
}

Option 3: Agent Kernel (Private Control Plane)

For developers running local agent fleets or requiring high-privacy execution.

System Requirements

OS: Linux, macOS, or Windows (WSL2)
Memory: 4GB RAM minimum
Disk: 1GB for logs and 0G indexer cache

Docker Installation

# Pull the latest image
docker pull opacus/agent-kernel:latest

# Run with your API key
docker run -d -p 3006:3006 \
  -e OPACUS_API_KEY=your_key \
  --name agent-kernel \
  opacus/agent-kernel:latest

Manual (Source) Installation

# Clone the repo
git clone https://github.com/opacus-xyz/opacus-core
cd opacus-core

# Install dependencies
npm install

# Start the kernel
npm run start

SDK Installation

Add Opacus capabilities to your existing TypeScript or Python projects.

Language	Command
TypeScript	`npm install opacus-sdk`
Python	`pip install opacus-sdk`
Rust	`cargo add opacus-sdk`

Verification

After installation, verify your setup is working correctly:

Agent Kernel Health Check

Run the following command to verify the kernel is running:

curl http://localhost:3006/health

Expected response: { "status": "ok" }

Test API Call

Make a test request with your API key:

curl -H "Authorization: Bearer sk_free_xxxx" \
  http://localhost:3006/v1/free-tier/me

You should receive your user profile JSON response.

Verify MCP Bridge (Claude Desktop)

Check your IDE's MCP connection status. In Claude Desktop, open Settings → Developer → MCP to confirm the Opacus server is connected.

Check Wallet Status

Verify your execution wallet has sufficient balance on Base or 0G Chain to fund operations.

Common Installation Issues

Port 3006 already in use

If you see "Address already in use" error:

Find the process: lsof -i :3006
Kill it: kill -9 <PID>
Or use a different port: PORT=3007 npm run start

API key not found

Ensure your API key is properly set:

In .env file: OPACUS_API_KEY=sk_free_xxxx
Or via environment: export OPACUS_API_KEY=sk_free_xxxx
Verify it's not expired in Agentboard Settings

0G network connection failed

If you see 0G network errors:

Check 0G network status: curl https://api-og.opacus.xyz/health
Try with a different RPC: Edit config.ts to use a fallback endpoint
Ensure your firewall allows outbound QUIC protocol (UDP port 443)

← Pricing & Plans

Troubleshooting →