584608a14e
Cherry-picked website/, scripts/generate-llms-full.sh, and deploy-docs.yml from joyshmitz's PR. Fixed workflow to trigger on main branch instead of docs/docusaurus-site. Features: - Docusaurus documentation site with llms.txt support - Environment-variable driven config (defaults to steveyegge org) - Automated llms-full.txt generation from docs - GitHub Pages deployment workflow Co-authored-by: joyshmitz <joyshmitz@users.noreply.github.com> 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Executed-By: beads/crew/dave Rig: beads Role: crew
162 lines
3.0 KiB
Markdown
162 lines
3.0 KiB
Markdown
---
|
|
id: configuration
|
|
title: Configuration
|
|
sidebar_position: 1
|
|
---
|
|
|
|
# Configuration
|
|
|
|
Complete configuration reference for beads.
|
|
|
|
## Configuration Locations
|
|
|
|
1. **Project config**: `.beads/config.toml` (highest priority)
|
|
2. **User config**: `~/.beads/config.toml`
|
|
3. **Environment variables**: `BEADS_*`
|
|
4. **Command-line flags**: (highest priority)
|
|
|
|
## Managing Configuration
|
|
|
|
```bash
|
|
# Get config value
|
|
bd config get import.orphan_handling
|
|
|
|
# Set config value
|
|
bd config set import.orphan_handling allow
|
|
|
|
# List all config
|
|
bd config list
|
|
|
|
# Reset to default
|
|
bd config reset import.orphan_handling
|
|
```
|
|
|
|
## Configuration Options
|
|
|
|
### Database
|
|
|
|
```toml
|
|
[database]
|
|
path = ".beads/beads.db" # Database file location
|
|
```
|
|
|
|
### ID Generation
|
|
|
|
```toml
|
|
[id]
|
|
prefix = "bd" # Issue ID prefix
|
|
hash_length = 4 # Hash length in IDs
|
|
```
|
|
|
|
### Import
|
|
|
|
```toml
|
|
[import]
|
|
orphan_handling = "allow" # allow|resurrect|skip|strict
|
|
dedupe_on_import = false # Run duplicate detection after import
|
|
```
|
|
|
|
| Mode | Behavior |
|
|
|------|----------|
|
|
| `allow` | Import orphans without validation (default) |
|
|
| `resurrect` | Restore deleted parents as tombstones |
|
|
| `skip` | Skip orphaned children with warning |
|
|
| `strict` | Fail if parent missing |
|
|
|
|
### Export
|
|
|
|
```toml
|
|
[export]
|
|
path = ".beads/issues.jsonl" # Export file location
|
|
auto_export = true # Auto-export on changes
|
|
debounce_seconds = 5 # Debounce interval
|
|
```
|
|
|
|
### Daemon
|
|
|
|
```toml
|
|
[daemon]
|
|
auto_start = true # Auto-start daemon
|
|
sync_interval = "5s" # Sync check interval
|
|
log_level = "info" # debug|info|warn|error
|
|
mode = "poll" # poll|events (experimental)
|
|
```
|
|
|
|
### Git
|
|
|
|
```toml
|
|
[git]
|
|
auto_commit = true # Auto-commit on sync
|
|
auto_push = true # Auto-push on sync
|
|
commit_message = "bd sync" # Default commit message
|
|
```
|
|
|
|
### Hooks
|
|
|
|
```toml
|
|
[hooks]
|
|
pre_commit = true # Enable pre-commit hook
|
|
post_merge = true # Enable post-merge hook
|
|
pre_push = true # Enable pre-push hook
|
|
```
|
|
|
|
### Deletions
|
|
|
|
```toml
|
|
[deletions]
|
|
retention_days = 30 # Keep deletion records for N days
|
|
prune_on_sync = true # Auto-prune old records
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
| Variable | Description |
|
|
|----------|-------------|
|
|
| `BEADS_DB` | Database path |
|
|
| `BEADS_NO_DAEMON` | Disable daemon |
|
|
| `BEADS_DAEMON_MODE` | Daemon mode (poll/events) |
|
|
| `BEADS_LOG_LEVEL` | Log level |
|
|
| `BEADS_CONFIG` | Config file path |
|
|
|
|
## Per-Command Override
|
|
|
|
```bash
|
|
# Override database
|
|
bd --db /tmp/test.db list
|
|
|
|
# Disable daemon for single command
|
|
bd --no-daemon create "Task"
|
|
```
|
|
|
|
## Example Configuration
|
|
|
|
`.beads/config.toml`:
|
|
|
|
```toml
|
|
[id]
|
|
prefix = "myproject"
|
|
hash_length = 6
|
|
|
|
[import]
|
|
orphan_handling = "resurrect"
|
|
dedupe_on_import = true
|
|
|
|
[daemon]
|
|
auto_start = true
|
|
sync_interval = "10s"
|
|
mode = "events"
|
|
|
|
[git]
|
|
auto_commit = true
|
|
auto_push = true
|
|
|
|
[deletions]
|
|
retention_days = 90
|
|
```
|
|
|
|
## Viewing Active Configuration
|
|
|
|
```bash
|
|
bd info --json | jq '.config'
|
|
```
|