HomeAbout usCovenantGitHubModelsServicesPrivacyInstall

Install CIRIS

Choose your preferred installation method. Works on Windows, macOS, and Linux.

📱 Android App Coming Soon

Mobile installation will be available via Google Play Store

RECOMMENDED

1. pip install (Preferred)

Fastest and easiest method. Includes first-run setup wizard. Works on Windows, macOS, and Linux.

pip install ciris-agent

Then run: ciris-agent to start the first-run wizard

Requirements: Python 3.10+

Other Installation Methods

2. Docker Compose

Pre-built containers from GitHub Container Registry. Isolated environment with no dependency management.

curl -sSL https://ciris.ai/install.sh | bash -s -- --docker
Requirements: Docker Engine 20.10+, docker compose plugin

3. Automated Installer Script

One-line installer that handles dependencies, setup, and services. Best for servers and production deployments.

curl -sSL https://ciris.ai/install.sh | bash
Requirements: Linux/macOS/WSL2, Python 3.10+, Node.js 18+

4. GitHub Clone (Development)

Clone the repository for development, customization, or contributing. Full source code access.

git clone https://github.com/CIRISAI/CIRISAgent.git

Then: Follow the README.md for manual setup instructions

5. CIRISManager (Enterprise/Canary)

Managed canary deployments with gradual rollouts, automated testing, and rollback capabilities. For production fleets.

CIRISManager provides automated blue-green deployments with health monitoring. Contact the team for deployment configurations.

Best for: Enterprise deployments, production fleets, managed infrastructure

Installer Script Options

Advanced options for the curl installer script (method #3)

Custom Installation Directory

Install to a custom location (default: ~/ciris)

curl -sSL https://ciris.ai/install.sh | bash -s -- --install-dir /opt/ciris
Dry Run (Preview Actions)

See what would be installed without making changes

curl -sSL https://ciris.ai/install.sh | bash -s -- --dry-run
Development Mode

Install development dependencies

curl -sSL https://ciris.ai/install.sh | bash -s -- --dev
Skip Service Installation

Install without systemd/launchd service setup

curl -sSL https://ciris.ai/install.sh | bash -s -- --skip-service

Troubleshooting

pip install fails

Ensure you have Python 3.10 or higher:

python --version

Try upgrading pip:

pip install --upgrade pip
Docker containers won't start

Check container logs:

docker logs ciris-agent

Verify Docker Compose file:

docker compose -f ~/ciris/docker-compose.yml ps
Need help?