Documentation

Everything you need to get started with Conciliate and synchronize your AI context across projects.

Quick Start

Get Conciliate running in under 5 minutes.

1. Install Conciliate

# Install from PyPI
pip install conciliate

2. Initialize in your project

# Navigate to your project
cd /path/to/your/project

# Initialize Conciliate
conciliate init

This creates a .conciliate.yaml config file.

3. Configure backend path

Edit .conciliate.yaml and set your backend path:

backend_path: ../backend    # Path to your backend
framework: auto             # Backend framework (auto-detected)
port: 5678                  # Server port
output_dir: .conciliate     # Output directory

4. Start watching

Choose your preferred mode:

# For REST API + file watching
conciliate watch

# For AI assistants (MCP mode)
conciliate mcp

You're all set!

Conciliate is now watching your backend for changes and exposing API context to your tools.

Need Help?

Visit PyPI

Check out the official PyPI page for installation details and version history.

Configuration Issues

Verify your .conciliate.yaml paths and permissions.