|
| 1 | +# Aar Configuration Guide |
| 2 | + |
| 3 | +Preconfigured config files for different LLM providers and use cases. Copy these to your Aar config directory to get started quickly. |
| 4 | + |
| 5 | +## Setup |
| 6 | + |
| 7 | +Copy any config file to your Aar configuration directory: |
| 8 | + |
| 9 | +**Linux / macOS:** |
| 10 | +```bash |
| 11 | +cp config/samples/config_claude.json ~/.aar/ |
| 12 | +``` |
| 13 | + |
| 14 | +**Windows:** |
| 15 | +```bash |
| 16 | +Copy-Item config\samples\config_claude.json -Destination $env:USERPROFILE\.aar\ |
| 17 | +``` |
| 18 | + |
| 19 | +Or manually create `~/.aar/` (or `%USERPROFILE%\.aar\` on Windows) and place your chosen config file there. |
| 20 | + |
| 21 | +## Available Configs |
| 22 | + |
| 23 | +| Config | Provider | Model | Best For | |
| 24 | +|--------|----------|-------|----------| |
| 25 | +| `config_claude.json` | Anthropic | Claude Sonnet 4.6 | General purpose, production-grade reasoning | |
| 26 | +| `config_openai.json` | OpenAI | GPT-4o | Fast iteration, multi-modal support | |
| 27 | +| `config_deepseek.json` | OpenAI-compatible | Deepseek-R1 | Cost-effective reasoning | |
| 28 | +| `config_qwen.json` | Ollama | Qwen 32B | Local inference, offline work | |
| 29 | +| `config_gemma.json` | Ollama | Gemma 27B | Lightweight local option | |
| 30 | +| `config_omnicoder.json` | Ollama | OmniCoder | Code-focused tasks | |
| 31 | +| `config_gemma_cost_sim.json` | Ollama | Gemma + Cost Tracking | Learning cost tracking without API spend | |
| 32 | + |
| 33 | +## Project Rules |
| 34 | + |
| 35 | +Place custom system prompts in `.agent/rules.md` to extend the agent's behavior. See `rules/rules.md` for the minimal ReAct system prompt used by default. |
| 36 | + |
| 37 | +## Troubleshooting |
| 38 | + |
| 39 | +**"Config not found"** |
| 40 | +- Ensure the file is in `~/.aar/` (Linux/Mac) or `%USERPROFILE%\.aar\` (Windows) |
| 41 | +- Check file name spelling and `.json` extension |
| 42 | + |
| 43 | +**"API key not found"** |
| 44 | +- Set the appropriate environment variable (see above) |
| 45 | +- Verify it's valid by testing directly: `curl -H "Authorization: Bearer $KEY" https://api.anthropic.com` |
| 46 | + |
| 47 | +**"Permission denied" on tool use** |
| 48 | +- Check `denied_paths` and `allowed_paths` in your config |
| 49 | +- Ensure `require_approval_for_writes` is false if running non-interactively |
| 50 | + |
| 51 | +**"Out of memory" or "timeout"** |
| 52 | +- Reduce `max_tokens`, `max_steps`, or increase `timeout` |
| 53 | +- Lower `max_output_chars` to prevent large output bloat |
| 54 | + |
| 55 | +## Learn More |
| 56 | + |
| 57 | +- **[Configuration Reference](../docs/configuration.md)** — Full `AgentConfig` documentation |
| 58 | +- **[Safety & Permissions](../docs/safety.md)** — Deny lists, path restrictions, sandbox modes |
| 59 | +- **[Providers](../docs/providers.md)** — Provider-specific setup and advanced options |
| 60 | +- **[Development](../docs/development.md)** — Programmatic config usage |
0 commit comments