| name | workbench-sync |
| description | Sync workflows for Workbench CLI. Use when aligning local work items with GitHub issues, creating branches, or reconciling doc backlinks. |
Key settings
.workbench/config.json: github.owner, github.repository, github.host, git.defaultBaseBranch.- Ensure
gh auth loginis complete before syncing issues.
Core workflows
- Import missing GitHub issues into local work items.
- Create missing GitHub issues for active work items.
- Create branches for active items.
- Sync doc backlinks and front matter.
Commands
Dry-run sync:
workbench sync --dry-run
Sync a specific item and prefer GitHub content:
workbench item sync --id TASK-0001 --prefer github
Bulk sync (local wins on conflicts):
workbench sync --items
Import unlinked GitHub issues (slower):
workbench sync --items --import-issues
Sync doc backlinks (include done items when needed):
workbench doc sync --all
workbench doc sync --all --include-done
Output
- New work items from GitHub issues.
- New GitHub issues and branches for active work items.
- Updated doc backlinks and front matter.
Guardrails
- Use
--dry-runbefore creating issues or branches. workbench syncdefaults to linked work items only; use--import-issuesto pull unlinked GitHub issues.- Terminal items (done/dropped) do not create issues or branches by default.
- Sync is not a replacement for specs/ADRs; create or update them during planning.