Aider Configuration Template

A comprehensive configuration template for Aider, the AI pair programming tool. This template covers all available configuration options including API keys, model selection, git integration, output customization, and automated linting/testing workflows.

What This Configuration Does

This template provides a complete `.aider.conf.yml` configuration file that can be placed in your home directory or at the root of your git repository. It includes settings for:

Instructions for AI Agent

When a user requests help with Aider configuration, follow these steps:

1. **Understand the user's needs**:

- Ask which Aider features they want to configure (model selection, git behavior, linting, etc.)

- Determine if they need a minimal config or comprehensive template

- Check if they have specific API keys or custom models to configure

2. **Create the configuration file**:

- Generate a `.aider.conf.yml` file in the appropriate location (home directory or git root)

- Uncomment and set values for requested options

- Include helpful comments explaining each setting

3. **Configure API keys** (if needed):

- For OpenAI/Anthropic keys in YAML: uncomment `openai-api-key` or `anthropic-api-key`

- For other providers: recommend creating a `.env` file instead

- Remind user to keep API keys secure and add `.env` to `.gitignore`

4. **Set up model preferences**:

- Uncomment the desired model shortcut (e.g., `sonnet: true` for Claude 3.5 Sonnet)

- Or set `model:` to a specific model name for custom/non-standard models

- Configure `weak-model` for commit messages if needed

5. **Configure git integration**:

- Enable/disable `auto-commits` based on user preference

- Set `attribute-author` and `attribute-committer` for proper attribution

- Configure `commit-prompt` for custom commit message styles

- Set `show-diffs: true` if user wants to review changes before commits

6. **Set up linting and testing** (if requested):

- Configure `lint-cmd` for each language (e.g., `"python: flake8 --select=E,W"`)

- Set `auto-lint: true` to run linting automatically after changes

- Configure `test-cmd` and `auto-test` if automated testing is desired

7. **Customize output appearance**:

- Set `dark-mode: true` or `light-mode: true` based on terminal theme

- Customize colors with `user-input-color`, `assistant-output-color`, etc.

- Set `code-theme` to preferred syntax highlighting theme

8. **Configure advanced features**:

- Set `map-tokens` to control repository context size (0 to disable)

- Enable `cache-prompts: true` for faster repeated operations

- Configure `max-chat-history-tokens` to limit context window usage

- Set `restore-chat-history: true` to continue previous sessions

9. **Add file specifications** (optional):

- Use `file:` array to specify default files to always include

- Use `read:` array for read-only reference files

- Configure `aiderignore` file path for excluding files

10. **Test and validate**:

- Run `aider --help` to verify configuration is loaded

- Check for any configuration errors or warnings

- Test with a simple chat session to ensure settings work as expected

Common Configuration Examples

Minimal Setup (Claude 3.5 Sonnet)

```yaml

anthropic-api-key: sk-ant-...

sonnet: true

auto-commits: true

dark-mode: true

```

Python Development with Linting

```yaml

model: gpt-4o

auto-commits: true

auto-lint: true

lint-cmd: "python: ruff check --fix"

dark-mode: true

show-diffs: true

```

Team Configuration (No Auto-Commit)

```yaml

model: claude-3-5-sonnet-20240620

auto-commits: false

dirty-commits: false

attribute-author: true

show-diffs: true

```

Important Notes

Configuration File Locations

Aider searches for `.aider.conf.yml` in this order:

1. Git repository root

2. Current working directory

3. Home directory (`~/.aider.conf.yml`)

Place the config file in the location that best suits your workflow (per-project or global).