|
| 1 | +# Installation Guide |
| 2 | + |
| 3 | +## Quick Start |
| 4 | + |
| 5 | +### 1. Prerequisites |
| 6 | + |
| 7 | +- Python 3.8 or higher |
| 8 | +- pip package manager |
| 9 | +- At least one AI CLI tool installed (Claude Code, Codex, Gemini CLI, or Copilot CLI) |
| 10 | + |
| 11 | +### 2. Install Dependencies |
| 12 | + |
| 13 | +```bash |
| 14 | +pip install -r requirements.txt |
| 15 | +``` |
| 16 | + |
| 17 | +Or install directly: |
| 18 | + |
| 19 | +```bash |
| 20 | +pip install click pyyaml colorama rich pydantic |
| 21 | +``` |
| 22 | + |
| 23 | +### 3. Verify Installation |
| 24 | + |
| 25 | +```bash |
| 26 | +# Make the CLI executable |
| 27 | +chmod +x ai-orchestrator |
| 28 | + |
| 29 | +# Verify it works |
| 30 | +./ai-orchestrator --help |
| 31 | + |
| 32 | +# Check version |
| 33 | +./ai-orchestrator version |
| 34 | + |
| 35 | +# Validate configuration |
| 36 | +./ai-orchestrator validate |
| 37 | + |
| 38 | +# Check available agents |
| 39 | +./ai-orchestrator agents |
| 40 | +``` |
| 41 | + |
| 42 | +### 4. Install AI CLI Tools |
| 43 | + |
| 44 | +You need at least one of the following AI CLI tools installed and authenticated: |
| 45 | + |
| 46 | +#### Claude Code |
| 47 | +```bash |
| 48 | +# Follow Claude Code installation instructions |
| 49 | +# Authenticate with your account |
| 50 | +claude auth login |
| 51 | +``` |
| 52 | + |
| 53 | +#### OpenAI Codex |
| 54 | +```bash |
| 55 | +# Install Codex CLI |
| 56 | +pip install openai-codex |
| 57 | + |
| 58 | +# Set API key |
| 59 | +export OPENAI_API_KEY="your-api-key" |
| 60 | +``` |
| 61 | + |
| 62 | +#### Google Gemini CLI |
| 63 | +```bash |
| 64 | +# Install Gemini CLI |
| 65 | +pip install google-generativeai |
| 66 | + |
| 67 | +# Authenticate |
| 68 | +gemini-cli auth login |
| 69 | +``` |
| 70 | + |
| 71 | +#### GitHub Copilot CLI |
| 72 | +```bash |
| 73 | +# Install GitHub CLI with Copilot extension |
| 74 | +gh extension install github/gh-copilot |
| 75 | + |
| 76 | +# Authenticate |
| 77 | +gh auth login |
| 78 | +``` |
| 79 | + |
| 80 | +### 5. Run Your First Task |
| 81 | + |
| 82 | +```bash |
| 83 | +./ai-orchestrator run "Create a function to validate email addresses" --workflow quick |
| 84 | +``` |
| 85 | + |
| 86 | +## Development Setup |
| 87 | + |
| 88 | +### 1. Clone Repository |
| 89 | + |
| 90 | +```bash |
| 91 | +git clone <repository-url> |
| 92 | +cd AI-Coding-Tools-Collaborative |
| 93 | +``` |
| 94 | + |
| 95 | +### 2. Create Virtual Environment (Recommended) |
| 96 | + |
| 97 | +```bash |
| 98 | +python3 -m venv venv |
| 99 | +source venv/bin/activate # On Windows: venv\Scripts\activate |
| 100 | +``` |
| 101 | + |
| 102 | +### 3. Install Dependencies |
| 103 | + |
| 104 | +```bash |
| 105 | +# Production dependencies |
| 106 | +pip install -r requirements.txt |
| 107 | + |
| 108 | +# Development dependencies |
| 109 | +pip install pytest pytest-cov |
| 110 | +``` |
| 111 | + |
| 112 | +### 4. Run Tests |
| 113 | + |
| 114 | +```bash |
| 115 | +# All tests |
| 116 | +pytest tests/ -v |
| 117 | + |
| 118 | +# Specific test file |
| 119 | +pytest tests/test_adapters.py -v |
| 120 | + |
| 121 | +# With coverage |
| 122 | +pytest --cov=orchestrator --cov=adapters tests/ |
| 123 | +``` |
| 124 | + |
| 125 | +### 5. Install in Development Mode |
| 126 | + |
| 127 | +```bash |
| 128 | +pip install -e . |
| 129 | +``` |
| 130 | + |
| 131 | +This allows you to edit the code and see changes immediately without reinstalling. |
| 132 | + |
| 133 | +## Configuration |
| 134 | + |
| 135 | +### Default Configuration |
| 136 | + |
| 137 | +The default configuration is located at `config/agents.yaml`. |
| 138 | + |
| 139 | +### Custom Configuration |
| 140 | + |
| 141 | +Create your own configuration file: |
| 142 | + |
| 143 | +```bash |
| 144 | +cp config/agents.yaml config/my-config.yaml |
| 145 | +``` |
| 146 | + |
| 147 | +Edit `config/my-config.yaml` to customize agents and workflows. |
| 148 | + |
| 149 | +Use it with: |
| 150 | + |
| 151 | +```bash |
| 152 | +./ai-orchestrator run "task" --config config/my-config.yaml |
| 153 | +``` |
| 154 | + |
| 155 | +### Environment Variables |
| 156 | + |
| 157 | +You can set these environment variables: |
| 158 | + |
| 159 | +- `AI_ORCHESTRATOR_CONFIG`: Path to default config file |
| 160 | +- `AI_ORCHESTRATOR_LOG_LEVEL`: Logging level (DEBUG, INFO, WARNING, ERROR) |
| 161 | +- `AI_ORCHESTRATOR_OUTPUT_DIR`: Default output directory |
| 162 | + |
| 163 | +## Adding to PATH |
| 164 | + |
| 165 | +### Linux/macOS |
| 166 | + |
| 167 | +```bash |
| 168 | +# Create symlink |
| 169 | +sudo ln -s $(pwd)/ai-orchestrator /usr/local/bin/ai-orchestrator |
| 170 | + |
| 171 | +# Or add to PATH in ~/.bashrc or ~/.zshrc |
| 172 | +export PATH=$PATH:/path/to/AI-Coding-Tools-Collaborative |
| 173 | +``` |
| 174 | + |
| 175 | +### Windows |
| 176 | + |
| 177 | +```powershell |
| 178 | +# Add to PATH using PowerShell |
| 179 | +$env:Path += ";C:\path\to\AI-Coding-Tools-Collaborative" |
| 180 | +
|
| 181 | +# Make permanent |
| 182 | +[Environment]::SetEnvironmentVariable("Path", $env:Path, [System.EnvironmentVariableTarget]::User) |
| 183 | +``` |
| 184 | + |
| 185 | +## Troubleshooting |
| 186 | + |
| 187 | +### Command Not Found |
| 188 | + |
| 189 | +If you get "command not found" errors: |
| 190 | + |
| 191 | +1. Ensure the script is executable: |
| 192 | + ```bash |
| 193 | + chmod +x ai-orchestrator |
| 194 | + ``` |
| 195 | + |
| 196 | +2. Use Python explicitly: |
| 197 | + ```bash |
| 198 | + python3 ai-orchestrator --help |
| 199 | + ``` |
| 200 | + |
| 201 | +### Import Errors |
| 202 | + |
| 203 | +If you get import errors: |
| 204 | + |
| 205 | +1. Ensure you're in the project directory |
| 206 | +2. Install dependencies: |
| 207 | + ```bash |
| 208 | + pip install -r requirements.txt |
| 209 | + ``` |
| 210 | + |
| 211 | +### Agent Not Available |
| 212 | + |
| 213 | +If agents show as "Not available": |
| 214 | + |
| 215 | +1. Install the CLI tool |
| 216 | +2. Authenticate with the service |
| 217 | +3. Verify with `which <command>` (e.g., `which claude`) |
| 218 | +4. Check configuration in `config/agents.yaml` |
| 219 | + |
| 220 | +### Permission Errors |
| 221 | + |
| 222 | +If you get permission errors: |
| 223 | + |
| 224 | +```bash |
| 225 | +# Fix file permissions |
| 226 | +chmod +x ai-orchestrator |
| 227 | + |
| 228 | +# Or run with Python |
| 229 | +python3 ./ai-orchestrator --help |
| 230 | +``` |
| 231 | + |
| 232 | +## Docker Installation (Optional) |
| 233 | + |
| 234 | +Create a `Dockerfile`: |
| 235 | + |
| 236 | +```dockerfile |
| 237 | +FROM python:3.11-slim |
| 238 | + |
| 239 | +WORKDIR /app |
| 240 | + |
| 241 | +COPY requirements.txt . |
| 242 | +RUN pip install --no-cache-dir -r requirements.txt |
| 243 | + |
| 244 | +COPY . . |
| 245 | + |
| 246 | +RUN chmod +x ai-orchestrator |
| 247 | + |
| 248 | +ENTRYPOINT ["./ai-orchestrator"] |
| 249 | +``` |
| 250 | + |
| 251 | +Build and run: |
| 252 | + |
| 253 | +```bash |
| 254 | +docker build -t ai-orchestrator . |
| 255 | +docker run -it ai-orchestrator --help |
| 256 | +``` |
| 257 | + |
| 258 | +## Verification |
| 259 | + |
| 260 | +Run the verification checklist: |
| 261 | + |
| 262 | +```bash |
| 263 | +# 1. Check Python version |
| 264 | +python3 --version # Should be 3.8+ |
| 265 | + |
| 266 | +# 2. Install dependencies |
| 267 | +pip install -r requirements.txt |
| 268 | + |
| 269 | +# 3. Validate configuration |
| 270 | +./ai-orchestrator validate |
| 271 | + |
| 272 | +# 4. Check agents |
| 273 | +./ai-orchestrator agents |
| 274 | + |
| 275 | +# 5. List workflows |
| 276 | +./ai-orchestrator workflows |
| 277 | + |
| 278 | +# 6. Run tests |
| 279 | +pytest tests/ -v |
| 280 | + |
| 281 | +# 7. Try a simple task (if agents available) |
| 282 | +./ai-orchestrator run "Create a hello world function" --dry-run |
| 283 | +``` |
| 284 | + |
| 285 | +## Next Steps |
| 286 | + |
| 287 | +After installation: |
| 288 | + |
| 289 | +1. Read the [README.md](README.md) for usage examples |
| 290 | +2. Check [docs/architecture.md](docs/architecture.md) to understand the system |
| 291 | +3. See [examples/sample_tasks.md](examples/sample_tasks.md) for task examples |
| 292 | +4. Read [docs/adding-agents.md](docs/adding-agents.md) to add custom agents |
| 293 | + |
| 294 | +## Support |
| 295 | + |
| 296 | +For issues: |
| 297 | +1. Check logs in `ai-orchestrator.log` |
| 298 | +2. Run with `--verbose` flag for detailed output |
| 299 | +3. Validate configuration with `./ai-orchestrator validate` |
| 300 | +4. Check GitHub issues for known problems |
0 commit comments