📱 Mobile Apps Now Available

Your personal AI agent on mobile: private, local-first, open source

Download on theApp Store Get it onGoogle Play

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

Run CIRIS in an isolated container environment. Best when you want reproducible local or server deployments.

docker compose up -d

Requirements: Docker Engine 20.10+, docker compose plugin, a project checkout with the compose file

3. 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

4. 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

Hello, CIRIS

The shortest path to a first response. Start the agent, then call it from Python. Both blocks below are copy-pasteable.

1. Start the agent

Run the API adapter. Defaults to port 8080. OBSERVER access requires no auth for local development.

pip install ciris-agent
ciris-agent --adapter api --port 8080

2. Call it from Python

Async SDK. response.processing_time_ms + response.state let you see the reasoning surface for every call.

pip install ciris-sdk

# hello_ciris.py
import asyncio
from ciris_sdk import CIRISClient

async def main():
    async with CIRISClient(
        base_url="http://localhost:8080",
    ) as client:
        response = await client.interact(
            "Hello, CIRIS!"
        )
        print(response.response)
        print(
            f"[{response.state}] "
            f"{response.processing_time_ms}ms"
        )

asyncio.run(main())

The SDK is pre-beta. Interfaces may change between releases. Full API surface (181 endpoints across 15 modules) documented in ciris_sdk on GitHub.

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?

Read the documentation

Report an issue

Join our Discord