Skip to main content

1. Clone the repository

2. Create environment & install dependencies

For development mode with testing and linting tools, run pip install -e ".[dev]" instead.

3. Initialize & Configure

This creates the files CogOS needs to run: Then configure your LLM provider (pick one):
Open configs/cogos.yaml and set api_key, model, base_url:

4. Verify installation

These examples run without an API key:

5. Run with LLM

Requires a configured API key:

Next Steps

Python API

Learn how to use CogOS programmatically.

CLI Reference

Explore the full command-line interface.

Service Management

Run CogOS as a daemon with auto-start on boot.

Schema Templates

Use preset templates or create your own.

Configuration

Customize LLM provider, persistence, and more.