Standardize start-work semantics to `bd update <id> --claim` across docs,
examples, templates, and website static LLM artifacts. Replaces
`--status in_progress` with `--claim` where the meaning is start-work.
Also fixes stale comment in llms.txt ("Update status" → "Start work").
Co-Authored-By: Valeriy Pavlovich <iqdoctor@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
||
|---|---|---|
| .. | ||
| README.md | ||
Team Workflow Example
This example demonstrates how to use beads for team collaboration with shared repositories.
Problem
When working as a team on a shared repository, you want to:
- Track issues collaboratively
- Keep everyone in sync via git
- Handle protected main branches
- Maintain clean git history
Solution
Use bd init --team to set up team collaboration with automatic sync and optional protected branch support.
Setup
Step 1: Initialize Team Workflow
# In your shared repository
cd my-project
# Run the team setup wizard
bd init --team
The wizard will:
- ✅ Detect your git configuration
- ✅ Ask if main branch is protected
- ✅ Configure sync branch (if needed)
- ✅ Set up automatic sync
- ✅ Enable team mode
Step 2: Protected Branch Configuration
If your main branch is protected (GitHub/GitLab), the wizard will:
- Create a separate
beads-metadatabranch for issue updates - Configure beads to commit to this branch automatically
- Set up periodic PR workflow for merging to main
Step 3: Team Members Join
Other team members just need to:
# Clone the repository
git clone https://github.com/org/project.git
cd project
# Initialize beads (auto-imports existing issues)
bd init
# Start working!
bd ready
How It Works
Direct Commits (No Protected Branch)
If main isn't protected:
# Create issue
bd create "Implement feature X" -p 1
# Dolt server auto-commits to main
# (or run 'bd sync' manually)
# Pull to see team's issues
git pull
bd list
Protected Branch Workflow
If main is protected:
# Create issue
bd create "Implement feature X" -p 1
# Auto-commits to beads-metadata branch
# (or run 'bd sync' manually)
# Push beads-metadata
git push origin beads-metadata
# Periodically: merge beads-metadata to main via PR
Configuration
The wizard configures:
team:
enabled: true
sync_branch: beads-metadata # or main if not protected
dolt:
auto-commit: on
Manual Configuration
# Enable team mode
bd config set team.enabled true
# Set sync branch
bd config set team.sync_branch beads-metadata
# Enable auto-commit
bd config set dolt.auto-commit on
Example Workflows
Scenario 1: Unprotected Main
# Alice creates an issue
bd create "Fix authentication bug" -p 1
# Auto-commits and pushes to main
# (auto-sync enabled)
# Bob pulls changes
git pull
bd list # Sees Alice's issue
# Bob claims it
bd update bd-abc --claim
# Auto-commits Bob's update
# Alice pulls and sees Bob is working on it
Scenario 2: Protected Main
# Alice creates an issue
bd create "Add new API endpoint" -p 1
# Auto-commits to beads-metadata
git push origin beads-metadata
# Bob pulls beads-metadata
git pull origin beads-metadata
bd list # Sees Alice's issue
# Later: merge beads-metadata to main via PR
git checkout main
git pull origin main
git merge beads-metadata
# Create PR, get approval, merge
Team Workflows
Daily Standup
# See what everyone's working on
bd list --status in_progress
# See what's ready for work
bd ready
# See recently closed issues
bd list --status closed --limit 10
Sprint Planning
# Create sprint issues
bd create "Implement user auth" -p 1
bd create "Add profile page" -p 1
bd create "Fix responsive layout" -p 2
# Assign to team members
bd update bd-abc --assignee alice
bd update bd-def --assignee bob
# Track dependencies
bd dep add bd-def bd-abc --type blocks
PR Integration
# Create issue for PR work
bd create "Refactor auth module" -p 1
# Work on it
bd update bd-abc --claim
# Open PR with issue reference
git push origin feature-branch
# PR title: "feat: refactor auth module (bd-abc)"
# Close when PR merges
bd close bd-abc --reason "PR #123 merged"
Sync Strategies
Auto-Sync (Recommended)
The Dolt server commits and pushes automatically when auto-commit is enabled:
bd config set dolt.auto-commit on
bd dolt start
Benefits:
- ✅ Always in sync
- ✅ No manual intervention
- ✅ Real-time collaboration
Manual Sync
Sync when you want:
bd sync # Export, commit, pull, import, push
Benefits:
- ✅ Full control
- ✅ Batch updates
- ✅ Review before push
Conflict Resolution
Hash-based IDs prevent most conflicts. Dolt handles merges natively using three-way merge, similar to git. If conflicts occur during bd sync:
# View conflicts
bd sql "SELECT * FROM dolt_conflicts"
# Resolve by accepting ours or theirs
bd sql "CALL dolt_conflicts_resolve('--ours')"
# OR
bd sql "CALL dolt_conflicts_resolve('--theirs')"
# Complete the sync
bd sync
Protected Branch Best Practices
For Protected Main:
-
Create beads-metadata branch
git checkout -b beads-metadata git push origin beads-metadata -
Configure protection rules
- Allow direct pushes to beads-metadata
- Require PR for main
-
Periodic PR workflow
# Once per day/sprint git checkout main git pull origin main git checkout beads-metadata git pull origin beads-metadata git checkout main git merge beads-metadata # Create PR, get approval, merge -
Keep beads-metadata clean
# After PR merges git checkout beads-metadata git rebase main git push origin beads-metadata --force-with-lease
Common Questions
Q: How do team members see each other's issues?
A: Issues are stored in Dolt, which supports distributed sync. Use bd sync to pull and push changes.
bd sync
bd list # See everyone's issues
Q: What if two people create issues at the same time?
A: Hash-based IDs prevent collisions. Even if created simultaneously, they get different IDs.
Q: How do I disable auto-sync?
A: Turn it off:
bd config set dolt.auto-commit off
# Sync manually
bd sync
Q: Can we use different sync branches per person?
A: Not recommended. Use a single shared branch for consistency. If needed:
bd config set sync.branch my-custom-branch
Q: What about CI/CD integration?
A: Add to your CI pipeline:
# In .github/workflows/main.yml
- name: Sync beads issues
run: |
bd sync
git push origin beads-metadata
Troubleshooting
Issue: Server not committing
Check server status:
bd doctor
Verify config:
bd config get dolt.auto-commit
Restart Dolt server:
bd dolt stop
bd dolt start
Issue: Merge conflicts
Dolt handles merges natively. If conflicts occur during sync:
bd sql "SELECT * FROM dolt_conflicts"
bd sql "CALL dolt_conflicts_resolve('--ours')"
bd sync
See GIT_INTEGRATION.md for details.
Issue: Issues not syncing
Manually sync:
bd sync
git push
Check for conflicts:
git status
bd validate --checks=conflicts