Install Clean

Run the installer from any directory:

npx @tryclean/create

The CLI will walk you through:

1. Preflight checks — verifies Docker is running and the environment is ready
2. License key — enter your API key (clean_sk_...) from the dashboard
3. Networking — provisions your org token
4. Config generation — creates .env and docker-compose.yml in a ./clean/ directory
5. Container launch — pulls images and starts the Clean server
6. Health checks — confirms the server is reachable
7. MCP config — writes agent config files (Claude, Cursor, etc.)

Prerequisites

• Docker installed and running
• Node.js 18+ (for npx)

What gets installed

Reconnect later

If you need to re-run the agent connection step without reinstalling:

npx @tryclean/create connect

Other CLI commands

npx @tryclean/create status   # Check service health
npx @tryclean/create update   # Pull latest images and restart
npx @tryclean/create logs     # Tail container logs
npx @tryclean/create backup   # Back up your vector data

Next step

Connect your agents →