fix(docs): update command syntax from '--' to single argument format for start, stop and status. (#1086)

This commit is contained in:
Michael
2026-01-15 12:43:07 +08:00
committed by GitHub
parent 9e639da5ba
commit b9d2799d29
19 changed files with 54 additions and 54 deletions

View File

@@ -158,7 +158,7 @@ func connectToDaemon(socketPath, dbPath string) error {
if health.Error != "" {
errMsg += fmt.Sprintf("\nError: %s", health.Error)
}
return fmt.Errorf("%s\n\nTry restarting the daemon:\n bd daemon --stop\n bd daemon", errMsg)
return fmt.Errorf("%s\n\nTry restarting the daemon:\n bd daemon stop\n bd daemon", errMsg)
}
// Set database path

View File

@@ -24,7 +24,7 @@ cd my-project
bd init
# Start daemon for auto-sync (optional)
bd daemon --start --auto-commit --auto-push
bd daemon start --auto-commit --auto-push
```
## Phase 1: Research & Planning

View File

@@ -27,7 +27,7 @@ cd my-project
bd init
# Start daemon for auto-sync (optional for teams)
bd daemon --start --auto-commit --auto-push
bd daemon start --auto-commit --auto-push
```
## Persona: Architect

View File

@@ -52,7 +52,7 @@ bd update bd-XXXXX --status in_progress
```bash
# Start daemon with auto-commit
bd daemon --start --auto-commit
bd daemon start --auto-commit
# All issue changes are now automatically committed to beads-metadata branch
```
@@ -221,14 +221,14 @@ JSONL is append-only and line-based, so conflicts are rare. If they occur:
The daemon creates it automatically on first commit. To create manually:
```bash
bd config get sync.branch # Verify it's set
bd daemon --stop && bd daemon --start # Daemon will create worktree
bd daemon stop && bd daemon start # Daemon will create worktree
```
**"Changes not syncing"**
Make sure:
- `bd config get sync.branch` returns the same value on all clones
- Daemon is running: `bd daemon --status`
- Daemon is running: `bd daemon status`
- Both clones have fetched: `git fetch origin beads-metadata`
## Advanced: GitHub Actions Integration

View File

@@ -216,7 +216,7 @@ bd close bd-abc --reason "PR #123 merged"
Daemon commits and pushes automatically:
```bash
bd daemon --start --auto-commit --auto-push
bd daemon start --auto-commit --auto-push
```
Benefits:
@@ -349,7 +349,7 @@ A: Add to your CI pipeline:
Check daemon status:
```bash
bd daemon --status
bd daemon status
bd daemons list
```
@@ -363,8 +363,8 @@ bd config get daemon.auto_push
Restart daemon:
```bash
bd daemon --stop
bd daemon --start --auto-commit --auto-push
bd daemon stop
bd daemon start --auto-commit --auto-push
```
### Issue: Merge conflicts in JSONL