Aider Configuration Template

A comprehensive configuration template for Aider, the AI pair programming tool. This template includes all available configuration options with explanations and sensible defaults.

What This Does

Provides a complete `.aider.conf.yml` configuration file template that covers:

Instructions

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

1. **Understand Requirements**

- Ask what aspects of Aider they want to configure (model, git behavior, UI, testing, etc.)

- Determine if they're setting up for the first time or modifying existing config

- Check if they need API keys stored separately in `.aider.env`

2. **Generate Configuration File**

- Create or update `.aider.conf.yml` in their project root or home directory

- Include relevant sections based on their needs

- Add comments explaining each setting

- Set sensible defaults for common use cases

3. **Key Configuration Sections**

**Model Settings:**

```yaml

# Main model for chat

model: gpt-4o

# Weaker model for summaries and commit messages

weak-model: gpt-4o-mini

# Editor model for code edits

editor-model: gpt-4o

```

**API Keys (use .aider.env for security):**

```yaml

# Keys should be in ~/.aider.env, not this file:

# OPENAI_API_KEY=sk-...

# ANTHROPIC_API_KEY=sk-ant-...

env-file: ~/.aider.env

```

**Git Behavior:**

```yaml

git: true # Enable git integration

auto-commits: true # Auto-commit LLM changes

dirty-commits: true # Allow commits when repo is dirty

attribute-author: true # Attribute changes to aider

gitignore: true # Add .aider* to .gitignore

```

**UI Customization:**

```yaml

dark-mode: true # Colors for dark terminal

pretty: true # Colorized output

stream: true # Stream responses

user-input-color: "#00cc00"

assistant-output-color: "#0088ff"

code-theme: monokai # Syntax highlighting theme

```

**Repository Mapping:**

```yaml

map-tokens: 2048 # Tokens for repo context (0 to disable)

map-refresh: auto # When to refresh: auto, always, files, manual

```

**Linting & Testing:**

```yaml

auto-lint: true # Lint after changes

lint-cmd:

- "python: ruff check --fix"

- "javascript: eslint --fix"

auto-test: false # Run tests after changes

test-cmd: pytest # Test command

```

**Performance:**

```yaml

cache-prompts: false # Enable prompt caching

timeout: 60 # API timeout in seconds

max-chat-history-tokens: 4096

```

4. **Environment File (.aider.env)**

- Create `~/.aider.env` or `.env` in git root for API keys

- Never commit this file (add to .gitignore)

- Format: `PROVIDER_API_KEY=value`

Example:

```bash

OPENAI_API_KEY=sk-proj-...

ANTHROPIC_API_KEY=sk-ant-...

GROQ_API_KEY=gsk_...

```

5. **Common Use Cases**

**For Python Projects:**

```yaml

model: gpt-4o

dark-mode: true

auto-commits: true

auto-lint: true

lint-cmd:

- "python: ruff check --fix"

test-cmd: pytest

map-tokens: 2048

```

**For Web Development:**

```yaml

model: gpt-4o

auto-lint: true

lint-cmd:

- "javascript: eslint --fix"

- "typescript: eslint --fix"

- "css: prettier --write"

show-diffs: true

```

**For Budget-Conscious Usage:**

```yaml

model: gpt-4o-mini # Cheaper model

weak-model: gpt-4o-mini

cache-prompts: true # Enable caching

map-tokens: 1024 # Reduce context

```

6. **Validation**

- Test configuration with: `aider --check-update`

- Verify git integration: `aider --git`

- Check model access: `aider --list-models <partial-name>`

7. **Important Notes**

- Configuration precedence: CLI flags > `.aider.conf.yml` > defaults

- Use `--config <path>` to specify alternate config file

- File paths in config are relative to config file location

- Only OpenAI and Anthropic keys can go in YAML; others must use .env

- Use `aider --help` to see all available options

Examples

**Example 1: First-time setup**

```

User: "Help me set up Aider for my Python project"

1. Create .aider.conf.yml with:

- model: gpt-4o

- dark-mode: true

- auto-commits: true

- Python linting with ruff

- pytest integration

2. Create ~/.aider.env with:

OPENAI_API_KEY=<their-key>

3. Test with: aider --yes-always /add <file>

```

**Example 2: Customize existing config**

```

User: "I want Aider to stop auto-committing and show diffs"

1. Update .aider.conf.yml:

auto-commits: false

show-diffs: true

2. Explain: They'll now approve each commit manually

```

Constraints