DocumentationGetting Started
Getting Started
Quick start guide to get CCCC up and running in your repository. Learn how to install, initialize, and run your first multi-agent collaboration session.
Quick Start
Get CCCC running in your repository in under 5 minutes.
Prerequisites
Before installing CCCC, ensure you have:
- Python 3.9+ installed on your system
- tmux for session management
- git for version control
- An existing git repository to work with
Installation
Install CCCC using pipx (recommended) or pip:
# Using pipx (recommended)
pipx install cccc-pair
# Or using pip in a virtual environment
python3 -m venv v
source v/bin/activate # On Windows: v\Scripts\activate
pip install cccc-pair
Initialize Your Repository
Navigate to your git repository and initialize CCCC:
cd /path/to/your/repo
cccc init
This command will:
- Create necessary configuration files
- Set up
POR.md(strategic board) - Set up
SUBPOR.md(task tracking) - Configure default agent settings
Verify Installation
Check that everything is configured correctly:
cccc doctor
This command validates:
- Python environment
- Required dependencies
- Git repository status
- Agent configurations
Run Your First Session
Start the CCCC orchestrator:
cccc run
CCCC will:
- Launch multiple AI agents in tmux sessions
- Begin collaborative work on your repository
- Update
POR.mdandSUBPOR.mdwith progress - Make small, reversible commits
Optional: Telegram Integration
Connect CCCC to Telegram for remote monitoring:
cccc telegram setup
Follow the prompts to link your Telegram bot. Once connected, you can:
- Monitor progress from anywhere
- Send instructions via Telegram
- Receive notifications on milestones
Next Steps
- Read Fundamentals to understand core concepts
- Explore Configuration for advanced settings
- Learn Usage patterns and best practices
Need Help?
- Check the GitHub repository for issues and discussions
- Review the full documentation for detailed guides
- Join our community discussions
Updated 10 months ago