johno/beads
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update documentation for CLI consolidation (bd-bxqv)

Browse Source 
Update docs to reflect CLI command restructuring:
- migrate-tombstones → migrate tombstones
- bd quickstart is now hidden, point to docs/QUICKSTART.md
- Add CLI consolidation section to CHANGELOG.md
- Remove quickstart from command tables

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Steve Yegge
2025-12-27 16:14:36 -08:00
parent d77a697cee
commit d0694e6171
8 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+8
View File
@@ -45,6 +45,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed ### Changed
- **CLI consolidation** (bd-9115) - Reduced top-level command clutter
- `bd cleanup`, `bd compact`, `bd reset` → `bd admin cleanup|compact|reset`
- `bd migrate-*` → `bd migrate hash-ids|issues|sync|tombstones`
- `bd cook` → `bd formula cook`
- `bd detect-pollution` → `bd doctor --check=pollution`
- `bd quickstart` hidden, use docs/QUICKSTART.md instead
- Hidden aliases maintain backwards compatibility with deprecation notices
- **Sync backoff and tips consolidation** (GH#753) - Smarter daemon - **Sync backoff and tips consolidation** (GH#753) - Smarter daemon
- Daemon uses exponential backoff for sync retries - Daemon uses exponential backoff for sync retries
- Tips consolidated from multiple sources - Tips consolidated from multiple sources
README.md
-1
View File
@@ -40,7 +40,6 @@ echo "Use 'bd' for task tracking" >> AGENTS.md
| `bd create "Title" -p 0` | Create a P0 task. | | `bd create "Title" -p 0` | Create a P0 task. |
| `bd dep add <child> <parent>` | Link tasks (blocks, related, parent-child). | | `bd dep add <child> <parent>` | Link tasks (blocks, related, parent-child). |
| `bd show <id>` | View task details and audit trail. | | `bd show <id>` | View task details and audit trail. |
| `bd quickstart` | Interactive guide for AI agents. |
## 🔗 Hierarchy & Workflow ## 🔗 Hierarchy & Workflow
commands/quickstart.md
+3 -7
View File
@@ -1,17 +1,13 @@
--- ---
description: Quick start guide for bd workflows description: Quick start guide for bd workflows (deprecated)
argument-hint: [] argument-hint: []
--- ---
Display a quick start guide showing common bd workflows and patterns. **Note:** The `bd quickstart` command is deprecated. See [docs/QUICKSTART.md](../docs/QUICKSTART.md) instead.
Use `bd quickstart` to see: The quickstart documentation covers:
- Getting started with bd - Getting started with bd
- Common workflow patterns - Common workflow patterns
- Basic commands - Basic commands
- Dependency management - Dependency management
- Git integration - Git integration
This is an interactive tutorial that walks through the essential bd commands and concepts for new users.
No arguments needed - just run `bd quickstart` to see the full guide.
docs/DELETIONS.md
+2 -2
View File
@@ -106,8 +106,8 @@ This ensures deletions propagate reliably while handling clock skew and delayed
Prior to v0.30, beads used a separate `deletions.jsonl` manifest. To migrate: Prior to v0.30, beads used a separate `deletions.jsonl` manifest. To migrate:
```bash ```bash
bd migrate-tombstones # Convert deletions.jsonl to inline tombstones bd migrate tombstones # Convert deletions.jsonl to inline tombstones
bd migrate-tombstones --dry-run # Preview changes first bd migrate tombstones --dry-run # Preview changes first
``` ```
The migration: The migration:
docs/EXTENDING.md
+1 -1
View File
@@ -713,5 +713,5 @@ This pattern scales from simple scripts to complex orchestrators like VC.
## See Also ## See Also
- [README.md](../README.md) - Complete bd documentation - [README.md](../README.md) - Complete bd documentation
- Run `bd quickstart` - Interactive tutorial - [QUICKSTART.md](QUICKSTART.md) - Quick start tutorial
- Check out VC's implementation at `github.com/steveyegge/vc` for a real-world example - Check out VC's implementation at `github.com/steveyegge/vc` for a real-world example
docs/INSTALLING.md
+1 -1
View File
@@ -296,7 +296,7 @@ After installation:
1. **Initialize a project**: `cd your-project && bd init` 1. **Initialize a project**: `cd your-project && bd init`
2. **Configure your agent**: Add bd instructions to `AGENTS.md` (see [README.md](../README.md#quick-start)) 2. **Configure your agent**: Add bd instructions to `AGENTS.md` (see [README.md](../README.md#quick-start))
3. **Learn the basics**: Run `bd quickstart` for an interactive tutorial 3. **Learn the basics**: See [QUICKSTART.md](QUICKSTART.md) for a tutorial
4. **Explore examples**: Check out the [examples/](../examples/) directory 4. **Explore examples**: Check out the [examples/](../examples/) directory
## Updating bd ## Updating bd
examples/bd-example-extension-go/README.md
+1 -1
View File
@@ -238,4 +238,4 @@ See [EXTENDING.md](../../EXTENDING.md) for more patterns and the VC implementati
- [EXTENDING.md](../../EXTENDING.md) - Complete extension guide - [EXTENDING.md](../../EXTENDING.md) - Complete extension guide
- [../../README.md](../../README.md) - bd documentation - [../../README.md](../../README.md) - bd documentation
- Run `bd quickstart` for an interactive tutorial - [QUICKSTART.md](../../docs/QUICKSTART.md) - Quick start tutorial
skills/beads/SKILL.md
-1
View File
@@ -441,7 +441,6 @@ Shows:
| `bd workflow` | Show workflow guide | "How do I use beads?" | | `bd workflow` | Show workflow guide | "How do I use beads?" |
| **ADVANCED COMMANDS** | | | | **ADVANCED COMMANDS** | | |
| `bd prime` | Refresh AI context | "Load bd workflow rules" | | `bd prime` | Refresh AI context | "Load bd workflow rules" |
| `bd quickstart` | Interactive tutorial | "Teach me beads basics" |
| `bd daemons` | Multi-repo daemon mgmt | "Manage all beads daemons" | | `bd daemons` | Multi-repo daemon mgmt | "Manage all beads daemons" |
| `bd version` | Version check | "Check bd version" | | `bd version` | Version check | "Check bd version" |
| `bd restore <id>` | Restore compacted issue | "Get full history from git" | | `bd restore <id>` | Restore compacted issue | "Get full history from git" |