fix(docs): update command syntax from '--' to single argument format for start, stop and status. (#1086)
This commit is contained in:
@@ -246,10 +246,10 @@ Event-driven mode is the **default** as of v0.21.0. No configuration needed.
|
||||
|
||||
```bash
|
||||
# Event-driven mode starts automatically
|
||||
bd daemon --start
|
||||
bd daemon start
|
||||
|
||||
# Explicitly enable (same as default)
|
||||
BEADS_DAEMON_MODE=events bd daemon --start
|
||||
BEADS_DAEMON_MODE=events bd daemon start
|
||||
```
|
||||
|
||||
**Available modes:**
|
||||
@@ -308,10 +308,10 @@ For edge cases (NFS, containers, WSL) where fsnotify is unreliable:
|
||||
|
||||
```bash
|
||||
# Explicitly use polling mode
|
||||
BEADS_DAEMON_MODE=poll bd daemon --start
|
||||
BEADS_DAEMON_MODE=poll bd daemon start
|
||||
|
||||
# With custom interval
|
||||
bd daemon --start --interval 10s
|
||||
bd daemon start --interval 10s
|
||||
```
|
||||
|
||||
### Troubleshooting Event-Driven Mode
|
||||
@@ -380,7 +380,7 @@ bd info --json | grep daemon_running
|
||||
export BEADS_AUTO_START_DAEMON=false
|
||||
|
||||
# Start manually
|
||||
bd daemon --start
|
||||
bd daemon start
|
||||
```
|
||||
|
||||
**Auto-start with exponential backoff:**
|
||||
|
||||
@@ -69,7 +69,7 @@ The sync branch (beads-sync) will contain:
|
||||
**2. Start the daemon with auto-commit:**
|
||||
|
||||
```bash
|
||||
bd daemon --start --auto-commit
|
||||
bd daemon start --auto-commit
|
||||
```
|
||||
|
||||
The daemon will automatically commit issue changes to the `beads-sync` branch.
|
||||
@@ -165,7 +165,7 @@ If you already have beads set up and want to switch to a separate branch:
|
||||
bd config set sync.branch beads-sync
|
||||
|
||||
# Start the daemon (it will create the worktree automatically)
|
||||
bd daemon --start --auto-commit
|
||||
bd daemon start --auto-commit
|
||||
```
|
||||
|
||||
### Daemon Configuration
|
||||
@@ -174,10 +174,10 @@ For automatic commits to the sync branch:
|
||||
|
||||
```bash
|
||||
# Start daemon with auto-commit
|
||||
bd daemon --start --auto-commit
|
||||
bd daemon start --auto-commit
|
||||
|
||||
# Or with auto-commit and auto-push
|
||||
bd daemon --start --auto-commit --auto-push
|
||||
bd daemon start --auto-commit --auto-push
|
||||
```
|
||||
|
||||
**Daemon modes:**
|
||||
@@ -193,7 +193,7 @@ You can also configure the sync branch via environment variable:
|
||||
|
||||
```bash
|
||||
export BEADS_SYNC_BRANCH=beads-sync
|
||||
bd daemon --start --auto-commit
|
||||
bd daemon start --auto-commit
|
||||
```
|
||||
|
||||
This is useful for CI/CD or temporary overrides.
|
||||
@@ -361,7 +361,7 @@ rm -rf .git/beads-worktrees/beads-sync
|
||||
git worktree prune
|
||||
|
||||
# Restart daemon (it will recreate the worktree)
|
||||
bd daemon --stop && bd daemon --start
|
||||
bd daemon stop && bd daemon start
|
||||
```
|
||||
|
||||
### "branch 'beads-sync' not found"
|
||||
@@ -389,13 +389,13 @@ Check daemon status and logs:
|
||||
|
||||
```bash
|
||||
# Check status
|
||||
bd daemon --status
|
||||
bd daemon status
|
||||
|
||||
# View logs
|
||||
tail -f ~/.beads/daemon.log
|
||||
|
||||
# Restart daemon
|
||||
bd daemon --stop && bd daemon --start
|
||||
bd daemon stop && bd daemon start
|
||||
```
|
||||
|
||||
Common issues:
|
||||
@@ -415,7 +415,7 @@ bd config get sync.branch # Should be the same (e.g., beads-sync)
|
||||
bd sync --no-push
|
||||
|
||||
# Check daemon is running
|
||||
bd daemon --status
|
||||
bd daemon status
|
||||
```
|
||||
|
||||
## FAQ
|
||||
@@ -440,7 +440,7 @@ Yes:
|
||||
|
||||
```bash
|
||||
bd config set sync.branch new-branch-name
|
||||
bd daemon --stop && bd daemon --start
|
||||
bd daemon stop && bd daemon start
|
||||
```
|
||||
|
||||
The old worktree will remain (no harm), and a new worktree will be created for the new branch.
|
||||
@@ -451,7 +451,7 @@ Unset the sync branch config:
|
||||
|
||||
```bash
|
||||
bd config set sync.branch ""
|
||||
bd daemon --stop && bd daemon --start
|
||||
bd daemon stop && bd daemon start
|
||||
```
|
||||
|
||||
Beads will go back to committing directly to your current branch.
|
||||
@@ -501,7 +501,7 @@ Yes, but the daemon will recreate it. If you want to clean up permanently:
|
||||
|
||||
```bash
|
||||
# Stop daemon
|
||||
bd daemon --stop
|
||||
bd daemon stop
|
||||
|
||||
# Remove worktree
|
||||
git worktree remove .git/beads-worktrees/beads-sync
|
||||
@@ -526,7 +526,7 @@ However, if you want fully automated sync:
|
||||
|
||||
```bash
|
||||
# WARNING: This bypasses branch protection!
|
||||
bd daemon --start --auto-commit --auto-push
|
||||
bd daemon start --auto-commit --auto-push
|
||||
bd sync --merge # Run periodically (e.g., via cron)
|
||||
```
|
||||
|
||||
@@ -672,7 +672,7 @@ If you have an existing beads setup committing to `main`:
|
||||
|
||||
2. **Restart daemon:**
|
||||
```bash
|
||||
bd daemon --stop && bd daemon --start
|
||||
bd daemon stop && bd daemon start
|
||||
```
|
||||
|
||||
3. **Verify:**
|
||||
@@ -693,7 +693,7 @@ If you want to stop using a sync branch:
|
||||
|
||||
2. **Restart daemon:**
|
||||
```bash
|
||||
bd daemon --stop && bd daemon --start
|
||||
bd daemon stop && bd daemon start
|
||||
```
|
||||
|
||||
Future commits will go to your current branch (e.g., `main`).
|
||||
|
||||
@@ -629,7 +629,7 @@ See [integrations/beads-mcp/README.md](../integrations/beads-mcp/README.md) for
|
||||
|
||||
**Common symptoms:**
|
||||
- "Database out of sync with JSONL" errors that persist after running `bd import`
|
||||
- `bd daemon --stop` fails with "operation not permitted"
|
||||
- `bd daemon stop` fails with "operation not permitted"
|
||||
- Cannot kill daemon process with `kill <pid>`
|
||||
- JSONL hash mismatch warnings (bd-160)
|
||||
- Commands intermittently fail with staleness errors
|
||||
|
||||
@@ -77,7 +77,7 @@ bd config set sync.branch ""
|
||||
|
||||
# Stop and restart daemon
|
||||
bd daemon stop
|
||||
bd daemon --start
|
||||
bd daemon start
|
||||
|
||||
# Clean up existing worktrees
|
||||
rm -rf .git/beads-worktrees
|
||||
|
||||
Reference in New Issue
Block a user