Skip to main content

​
What you will learn

  • System prerequisites for running Clavion
  • How to install from source using Git and npm
  • How to install using Docker
  • How to verify your installation

​
Prerequisites

RequirementMinimumPurpose
Node.js20+Runtime for ISCL Core and adapters
npm9+Dependency management (workspaces)
Git2.xClone the repository
Docker24+Optional — sandbox execution, Docker Compose stack
Foundry / AnvilLatestOptional — local EVM fork for E2E testing

​
Install from source

1

Clone the repository

git clone https://github.com/clavion/clavion.git
cd clavion
2

Install dependencies

npm install
This installs all workspace packages. better-sqlite3 compiles a native addon — if you see build errors, ensure you have a C++ toolchain installed (xcode-select --install on macOS, build-essential on Ubuntu).
3

Build TypeScript

npm run build
Uses TypeScript project references (tsc -b) to build all packages in dependency order.
4

Run tests

npm test
Runs the full test suite (639+ tests). All tests should pass.

​
Install with Docker

For a containerized setup without local Node.js: 
# Build the Docker image
docker build -f docker/Dockerfile.core -t clavion-core .

# Start with Docker Compose (ISCL Core + Anvil)
docker compose -f docker/compose.yaml up -d
See Docker Compose Stack for the full multi-service setup.

​
Verify installation

Start the development server:
npm run dev
Check health:
curl http://localhost:3100/v1/health
Expected response:
{
  "status": "ok",
  "version": "0.1.0",
  "uptime": 1.234
}

​
Directory structure

After installation, the repository has this layout: 
clavion/
├── packages/           # All workspace packages
│   ├── types/          # Shared interfaces and schemas
│   ├── core/           # API server, tx builders, approval
│   ├── signer/         # Encrypted keystore and signing
│   ├── audit/          # Append-only audit trail (SQLite)
│   ├── policy/         # Policy engine and config
│   ├── preflight/      # Risk scoring and simulation
│   ├── registry/       # Skill manifest validation
│   ├── sandbox/        # Container isolation runner
│   ├── adapter-openclaw/ # OpenClaw integration
│   ├── adapter-mcp/    # MCP server for Claude/Cursor
│   ├── plugin-eliza/   # ElizaOS plugin
│   ├── adapter-telegram/ # Telegram bot
│   └── cli/            # Key management CLI
├── tests/              # Cross-package integration and security tests
├── tools/              # Fixture generation utilities
├── docker/             # Dockerfile and Compose config
└── docs/               # Internal documentation

​
Next steps