Systematic cleanup of stale documentation references left over from the Dolt migration: - Replace all 'bd sync' → 'bd dolt push' / 'bd dolt pull' across 40+ files - Replace all 'bd import' → 'bd init --from-jsonl' or remove - Replace 'bd init --branch' → note about refs/dolt/data separation - Fix AGENT_INSTRUCTIONS.md (highest impact: agents read this directly) - Fix npm-package, claude-plugin, integrations, examples, website docs Add scripts/check-doc-flags.sh to catch stale doc references: - Checks for removed commands (bd sync, bd import) - Checks for removed flags (bd init --branch) - Warns on legacy SQLite/beads.db references - Compares CLI_REFERENCE.md against bd help --all Add CI job (check-doc-flags) and Makefile target (check-docs) to gate PRs against doc freshness. Prior art: feat/help-doc-generator branch has bd help --doc/--list for generating docs FROM CLI output. This script validates docs AGAINST CLI output — complementary approaches. Amp-Thread-ID: https://ampcode.com/threads/T-019cde77-0722-7353-b63a-1779a5773ca6 Co-authored-by: Amp <amp@ampcode.com>
116 lines
1.8 KiB
Markdown
116 lines
1.8 KiB
Markdown
---
|
|
id: aider
|
|
title: Aider
|
|
sidebar_position: 3
|
|
---
|
|
|
|
# Aider Integration
|
|
|
|
How to use beads with Aider.
|
|
|
|
## Setup
|
|
|
|
### Quick Setup
|
|
|
|
```bash
|
|
bd setup aider
|
|
```
|
|
|
|
This creates/updates `.aider.conf.yml` with beads context.
|
|
|
|
### Verify Setup
|
|
|
|
```bash
|
|
bd setup aider --check
|
|
```
|
|
|
|
## Configuration
|
|
|
|
The setup adds to `.aider.conf.yml`:
|
|
|
|
```yaml
|
|
# Beads integration — bd prime provides issue context
|
|
auto-commits: false
|
|
```
|
|
|
|
## Workflow
|
|
|
|
### Start Session
|
|
|
|
```bash
|
|
# Aider will have access to issues via .aider.conf.yml
|
|
aider
|
|
|
|
# Or manually inject context
|
|
bd prime | aider --message-file -
|
|
```
|
|
|
|
### During Work
|
|
|
|
Use bd commands alongside aider:
|
|
|
|
```bash
|
|
# In another terminal or after exiting aider
|
|
bd create "Found bug during work" --deps discovered-from:bd-42 --json
|
|
bd update bd-42 --claim
|
|
bd ready
|
|
```
|
|
|
|
### End Session
|
|
|
|
```bash
|
|
bd dolt push
|
|
```
|
|
|
|
## Best Practices
|
|
|
|
1. **Keep issues visible** - Use `bd prime` to inject issue context
|
|
2. **Push regularly** - Run `bd dolt push` after significant changes
|
|
3. **Use discovered-from** - Track issues found during work
|
|
4. **Document context** - Include descriptions in issues
|
|
|
|
## Example Workflow
|
|
|
|
```bash
|
|
# 1. Check ready work
|
|
bd ready
|
|
|
|
# 2. Start aider with issue context
|
|
aider --message "Working on bd-42: Fix auth bug"
|
|
|
|
# 3. Work in aider...
|
|
|
|
# 4. Create discovered issues
|
|
bd create "Found related bug" --deps discovered-from:bd-42 --json
|
|
|
|
# 5. Complete and push
|
|
bd close bd-42 --reason "Fixed"
|
|
bd dolt push
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
### Config not loading
|
|
|
|
```bash
|
|
# Check config exists
|
|
cat .aider.conf.yml
|
|
|
|
# Regenerate
|
|
bd setup aider
|
|
```
|
|
|
|
### Issues not visible
|
|
|
|
```bash
|
|
# Use bd prime to inject issue context
|
|
bd prime | aider --message-file -
|
|
|
|
# Or check database health
|
|
bd doctor
|
|
```
|
|
|
|
## See Also
|
|
|
|
- [Claude Code](/integrations/claude-code)
|
|
- [IDE Setup](/getting-started/ide-setup)
|