Skip to main content

Install

Requirements: Node.js 18+ for the Engine. Rust toolchain is only needed for cargo install or building TUI from source.

Verify installation

complior --version
# complior 11.0.0

complior doctor
# ✓ Engine: OK
# ✓ Node.js: v22.1.0
# ✓ TUI: OK
# ✓ MCP: OK
All green checks mean Complior is ready. If any component shows an issue, complior doctor will suggest how to fix it.

LLM configuration

Some features require an LLM API key: complior scan --llm, complior eval --llm, complior fix --ai. After complior init, add your LLM settings to .complior/.env:
# .complior/.env
LLM_PROVIDER=openai              # openai | anthropic | openrouter | ollama
LLM_MODEL=gpt-4o                 # model name
LLM_API_KEY=sk-...               # your API key
LLM_PROVIDER=openai
LLM_MODEL=gpt-4o
LLM_API_KEY=sk-...
.complior/.env is gitignored by default. Never commit API keys to version control.

What gets installed

ComponentDescriptionSize
EngineTypeScript daemon — scanner, fixer, passport service, HTTP API~15 MB
CLIRust binary — 30+ commands, headless mode for CI/CD~10 MB
TUITerminal dashboard — 9 interactive pages (ratatui)Included in CLI
MCP ServerProtocol server for AI agents (stdio)Included in Engine

Configure for AI agents

To use Complior with Claude Code, Cursor, or other MCP-compatible agents:
Add to ~/.claude/mcp.json:
{
  "mcpServers": {
    "complior": {
      "command": "complior",
      "args": ["mcp"]
    }
  }
}

Next steps

Quick Start

Run your first scan in under 3 minutes.