get-tbd 0.1.13 → 0.1.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/README.md +47 -28
  2. package/dist/bin.mjs +410 -170
  3. package/dist/bin.mjs.map +1 -1
  4. package/dist/cli.mjs +202 -94
  5. package/dist/cli.mjs.map +1 -1
  6. package/dist/docs/README.md +47 -28
  7. package/dist/docs/SKILL.md +61 -18
  8. package/dist/docs/guidelines/bun-monorepo-patterns.md +2096 -0
  9. package/dist/docs/guidelines/cli-agent-skill-patterns.md +79 -5
  10. package/dist/docs/guidelines/error-handling-rules.md +66 -0
  11. package/dist/docs/guidelines/pnpm-monorepo-patterns.md +2868 -0
  12. package/dist/docs/guidelines/release-notes-guidelines.md +140 -0
  13. package/dist/docs/guidelines/{sync-troubleshooting.md → tbd-sync-troubleshooting.md} +1 -1
  14. package/dist/docs/guidelines/typescript-sorting-patterns.md +234 -0
  15. package/dist/docs/guidelines/typescript-yaml-handling-rules.md +195 -0
  16. package/dist/docs/install/claude-header.md +13 -6
  17. package/dist/docs/shortcuts/standard/agent-handoff.md +1 -0
  18. package/dist/docs/shortcuts/standard/checkout-third-party-repo.md +50 -0
  19. package/dist/docs/shortcuts/standard/{cleanup-all.md → code-cleanup-all.md} +3 -2
  20. package/dist/docs/shortcuts/standard/{cleanup-update-docstrings.md → code-cleanup-docstrings.md} +1 -0
  21. package/dist/docs/shortcuts/standard/{cleanup-remove-trivial-tests.md → code-cleanup-tests.md} +1 -0
  22. package/dist/docs/shortcuts/standard/{commit-code.md → code-review-and-commit.md} +1 -0
  23. package/dist/docs/shortcuts/standard/coding-spike.md +54 -0
  24. package/dist/docs/shortcuts/standard/create-or-update-pr-simple.md +1 -0
  25. package/dist/docs/shortcuts/standard/create-or-update-pr-with-validation-plan.md +1 -0
  26. package/dist/docs/shortcuts/standard/implement-beads.md +1 -0
  27. package/dist/docs/shortcuts/standard/merge-upstream.md +1 -0
  28. package/dist/docs/shortcuts/standard/new-architecture-doc.md +1 -0
  29. package/dist/docs/shortcuts/standard/new-guideline.md +8 -0
  30. package/dist/docs/shortcuts/standard/new-plan-spec.md +1 -0
  31. package/dist/docs/shortcuts/standard/new-research-brief.md +1 -0
  32. package/dist/docs/shortcuts/standard/new-shortcut.md +27 -1
  33. package/dist/docs/shortcuts/standard/new-validation-plan.md +1 -0
  34. package/dist/docs/shortcuts/standard/plan-implementation-with-beads.md +1 -0
  35. package/dist/docs/shortcuts/standard/precommit-process.md +1 -0
  36. package/dist/docs/shortcuts/standard/review-code-python.md +1 -0
  37. package/dist/docs/shortcuts/standard/review-code-typescript.md +1 -0
  38. package/dist/docs/shortcuts/standard/review-code.md +1 -0
  39. package/dist/docs/shortcuts/standard/review-github-pr.md +89 -17
  40. package/dist/docs/shortcuts/standard/revise-all-architecture-docs.md +1 -0
  41. package/dist/docs/shortcuts/standard/revise-architecture-doc.md +1 -0
  42. package/dist/docs/shortcuts/standard/setup-github-cli.md +1 -0
  43. package/dist/docs/shortcuts/standard/sync-failure-recovery.md +6 -53
  44. package/dist/docs/shortcuts/standard/update-specs-status.md +1 -0
  45. package/dist/docs/shortcuts/standard/welcome-user.md +2 -1
  46. package/dist/docs/shortcuts/system/skill-brief.md +1 -1
  47. package/dist/docs/shortcuts/system/skill.md +48 -12
  48. package/dist/docs/skill-brief.md +1 -1
  49. package/dist/docs/tbd-design.md +13 -1
  50. package/dist/index.d.mts +20 -6
  51. package/dist/index.mjs +2 -2
  52. package/dist/{src-BfhjLZXE.mjs → src-Ct16P2Ox.mjs} +154 -22
  53. package/dist/src-Ct16P2Ox.mjs.map +1 -0
  54. package/dist/tbd +410 -170
  55. package/package.json +1 -1
  56. package/dist/docs/guidelines/typescript-monorepo-patterns.md +0 -72
  57. package/dist/src-BfhjLZXE.mjs.map +0 -1
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Commit Code
3
3
  description: Run pre-commit checks, review changes, and commit code
4
+ category: git
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  We track work as beads using tbd.
@@ -0,0 +1,54 @@
1
+ ---
2
+ title: Coding Spike
3
+ description: Prototype to validate a spec through hands-on implementation
4
+ category: planning
5
+ author: Kam Leung with LLM assistance
6
+ ---
7
+ We track work as beads using tbd.
8
+ Run `tbd` for more on using tbd and current status.
9
+
10
+ A **coding spike** is time-boxed exploration to validate technical assumptions through
11
+ implementation.
12
+ Write production-quality code to uncover real constraints, but treat this
13
+ as a learning exercise—the code may be discarded or revised.
14
+
15
+ Instructions:
16
+
17
+ Create a to-do list with the following items then perform all of them:
18
+
19
+ 1. Create a spike bead:
20
+ ```bash
21
+ tbd create "Spike: <what you're validating>" --type task
22
+ ```
23
+
24
+ 2. Understand the spec and identify technical questions that need answers.
25
+
26
+ 3. Define spike scope: What’s the minimum implementation needed to learn?
27
+ What will you explicitly NOT build?
28
+
29
+ 4. Build production-quality prototypes:
30
+ - Follow project conventions and include tests
31
+ - Focus on uncertain approaches that need validation
32
+ - Prioritize learning over feature completeness
33
+ - Create child beads for distinct components if helpful
34
+
35
+ 5. Capture learnings as you go—document in the spec given to you:
36
+ - Spec gaps, ambiguities, or errors found
37
+ - Complexity surprises (harder or easier than expected)
38
+ - Better approaches or patterns discovered
39
+ - New risks, dependencies, or performance concerns
40
+
41
+ 6. Refine the specification with findings:
42
+ - Clarify ambiguous sections
43
+ - Correct technical details that proved wrong
44
+ - Document discovered risks and update estimates
45
+
46
+ 7. Decide on spike code: keep and refine, keep as reference, or discard.
47
+
48
+ 8. Close the spike:
49
+ ```bash
50
+ tbd close <spike-bead-id> --reason "Spike complete: <outcome summary>"
51
+ tbd sync
52
+ ```
53
+
54
+ 9. Report findings and recommend next steps.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Create or Update PR (Simple)
3
3
  description: Create or update a pull request with a concise summary
4
+ category: git
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  We track work as beads using tbd.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Create or Update PR with Validation Plan
3
3
  description: Create or update a pull request with a detailed test/validation plan
4
+ category: git
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  We track work as beads using tbd.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Implement Beads
3
3
  description: Implement beads from a spec, following TDD and project rules
4
+ category: planning
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  We track work as beads using tbd.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Merge Upstream
3
3
  description: Merge origin/main into current branch with conflict resolution
4
+ category: git
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  Merge upstream changes from origin/main into the current branch.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: New Architecture Doc
3
3
  description: Create an architecture document for a system or component design
4
+ category: documentation
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  We track work as beads using tbd.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: New Guideline
3
3
  description: Create a new coding guideline document for tbd
4
+ category: meta
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  This shortcut helps create new guideline documents that agents can reference via
@@ -87,6 +88,11 @@ Create a to-do list with the following items then perform all of them:
87
88
  - Rebuild tbd: `pnpm build` (in packages/tbd/)
88
89
  - Verify bundled: check `packages/tbd/dist/docs/guidelines/<name>.md`
89
90
 
91
+ 9. **Update documentation** (for official guidelines):
92
+ - Add to root `README.md` “Built-in Engineering Knowledge” table
93
+ - Sync docs cache: `tbd setup --auto` (updates `.tbd/docs/`)
94
+ - Note: `packages/tbd/README.md` is auto-copied from root during build
95
+
90
96
  ## Guideline Quality Checklist
91
97
 
92
98
  - [ ] Frontmatter has title and description
@@ -96,6 +102,8 @@ Create a to-do list with the following items then perform all of them:
96
102
  - [ ] Cross-references to related guidelines
97
103
  - [ ] No relative links (use full URLs for external refs)
98
104
  - [ ] Tested with `tbd guidelines <name>`
105
+ - [ ] (Official) Added to root README.md “Built-in Engineering Knowledge” table
106
+ - [ ] (Official) Docs cache synced: `tbd setup --auto`
99
107
 
100
108
  ## Example Frontmatter
101
109
 
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: New Plan Spec
3
3
  description: Create a new feature planning specification document
4
+ category: planning
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  We track work as beads using tbd.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: New Research Doc
3
3
  description: Create a research document for investigating a topic or technology
4
+ category: documentation
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  We track work as beads using tbd.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: New Shortcut
3
3
  description: Create a new shortcut (reusable instruction template) for tbd
4
+ category: meta
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  Create a new shortcut for `tbd shortcut <name>`.
@@ -16,6 +17,7 @@ Create a new shortcut for `tbd shortcut <name>`.
16
17
  ---
17
18
  title: [Title]
18
19
  description: [One line for --list output]
20
+ category: [category]
19
21
  author: Joshua Levy (github.com/jlevy) with LLM assistance
20
22
  ---
21
23
  [Concise instructions. Focus on what's specific to this task.
@@ -23,11 +25,26 @@ Skip obvious steps the agent would figure out.
23
25
  Reference other shortcuts/guidelines/templates as needed.]
24
26
  ```
25
27
 
28
+ ## Categories
29
+
30
+ Use one of these standard categories in the frontmatter:
31
+
32
+ | Category | Use For |
33
+ | --- | --- |
34
+ | `planning` | Spec creation, implementation planning, validation plans |
35
+ | `documentation` | Research briefs, architecture docs, doc revisions |
36
+ | `review` | Code review, PR review |
37
+ | `git` | Commits, PRs, merging, pre-commit workflows |
38
+ | `cleanup` | Code cleanup, dead code removal, test cleanup |
39
+ | `session` | Session management, handoffs, setup, recovery |
40
+ | `meta` | Creating new shortcuts/guidelines |
41
+ | `research` | Research tasks, third-party code checkout |
42
+
26
43
  ## Naming
27
44
 
28
45
  Use kebab-case: `new-<thing>`, `<verb>-<noun>`, `<thing>-<variant>`
29
46
 
30
- Examples: `commit-code`, `new-plan-spec`, `review-code-typescript`
47
+ Examples: `code-review-and-commit`, `new-plan-spec`, `review-code-typescript`
31
48
 
32
49
  ## Key Principles
33
50
 
@@ -45,6 +62,15 @@ tbd shortcut --list # Verify listing
45
62
 
46
63
  For official shortcuts: `pnpm build` in packages/tbd/
47
64
 
65
+ ## Documentation Updates (Official Shortcuts)
66
+
67
+ For official shortcuts added to `packages/tbd/docs/shortcuts/standard/`:
68
+
69
+ 1. **Update root README.md** — Add to the “Available shortcuts” table (grouped by
70
+ category: Planning, Documentation, Review, Git, Cleanup, Session, Meta)
71
+ 2. **Sync docs cache** — Run `tbd setup --auto` to update `.tbd/docs/`
72
+ 3. **Rebuild** — `pnpm build` in packages/tbd/ (also copies README to package)
73
+
48
74
  ## Shortcuts vs Guidelines
49
75
 
50
76
  - **Shortcuts**: Workflows to follow (process)
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: New Validation Plan
3
3
  description: Create a validation/test plan showing what's tested and what remains
4
+ category: planning
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  Create a validation plan documenting completed and remaining validation work.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Plan Implementation with Beads
3
3
  description: Create implementation beads from a feature planning spec
4
+ category: planning
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  Break a plan spec (or other work) into implementation beads.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Pre-Commit Process
3
3
  description: Full pre-commit checklist including spec sync, code review, and testing
4
+ category: git
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  We track work as beads using tbd.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Review Code (Python)
3
3
  description: Python-focused code review (language-specific rules only)
4
+ category: review
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  This shortcut performs a **Python-focused** code review, checking Python-specific best
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Review Code (TypeScript)
3
3
  description: TypeScript-focused code review (language-specific rules only)
4
+ category: review
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  This shortcut performs a **TypeScript-focused** code review, checking
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Review Code
3
3
  description: Comprehensive code review for uncommitted changes, branch work, or GitHub PRs
4
+ category: review
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  This is the **core code review** shortcut.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Review GitHub PR
3
3
  description: Review a GitHub pull request with follow-up actions (comment, fix, CI check)
4
+ category: review
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  This shortcut reviews a **GitHub pull request** and handles GitHub-specific follow-ups
@@ -34,36 +35,107 @@ Create a to-do list with the following items then perform all of them:
34
35
  - Run `tbd shortcut review-code` using the **GitHub PR** scope
35
36
  - The diff is obtained via: `gh pr diff <PR_NUMBER> --repo $REPO`
36
37
 
37
- 5. **Compile full review:** Combine the code review findings with GitHub-specific info:
38
+ 5. **Check documentation consistency:**
39
+ - Review any specs referenced by the PR in `docs/project/specs/active/`
40
+ - Check if `docs/development.md` needs updates for behavioral changes
41
+ - Check if architecture docs in `docs/project/architecture/` need updates
42
+ - Note any documentation that is out of sync with the code changes
43
+
44
+ 6. **Review existing PR comments:**
45
+ - Get PR comments: `gh pr view <PR_NUMBER> --repo $REPO --comments`
46
+ - For review comments: `gh api repos/{owner}/{repo}/pulls/<PR_NUMBER>/comments`
47
+ - Note any unresolved comments or requested changes
48
+
49
+ 7. **Compile full review:** Combine the code review findings with GitHub-specific info:
38
50
 
39
51
  - **Summary**: Brief assessment (1-2 sentences)
40
52
  - **Strengths**: What’s done well (if any)
41
53
  - **Issues**: Problems found with `file:line` references and suggested fixes
54
+ - **Documentation gaps**: Specs or docs that need updating
55
+ - **Unresolved comments**: Any PR comments still needing attention
42
56
  - **Suggestions**: Optional improvements (not blockers)
43
57
  - **CI Status**: Current state of checks (passing/failing/pending)
44
58
 
45
- 6. **Determine next action:**
59
+ 8. **Determine next action:**
46
60
  - If the user already specified what to do (e.g., “review and comment”, “review and
47
61
  fix”), follow those instructions
48
62
  - Otherwise, present the review and ask the user:
49
63
  - **Add as PR comment**: Post the review as a comment on the PR
50
- - **Create fix beads**: Create tbd beads for issues found and begin fixing
64
+ - **Fix with beads**: Create tbd beads for every issue and systematically fix them
51
65
  - **Report only**: Just output the review (no action)
52
66
 
53
- 7. **Take the requested action:**
67
+ 9. **Take the requested action:**
68
+
69
+ ### If adding as comment:
70
+
71
+ ```bash
72
+ gh pr review <PR_NUMBER> --repo $REPO --comment --body "<review>"
73
+ ```
74
+
75
+ ### If fixing with beads (comprehensive tracking):
76
+
77
+ This approach ensures **every issue is tracked** and nothing is lost:
78
+
79
+ a. **Create a parent bead** for the PR review:
80
+ ```bash
81
+ tbd create "Review PR #<NUMBER>: <title>" --type task --priority P1
82
+ ```
83
+
84
+ b. **Create child beads for EVERY issue found:**
85
+ ```bash
86
+ tbd create "<issue description>" --type bug --parent <parent-bead-id>
87
+ ```
88
+
89
+ Categories to track as beads:
90
+ - Code issues (bugs, antipatterns, missing error handling)
91
+ - Test gaps (missing tests, inadequate coverage)
92
+ - Documentation gaps (specs out of sync, missing updates)
93
+ - CI failures (each failing check)
94
+ - Unresolved PR comments
95
+
96
+ Each bead description should include:
97
+ - File and line number (e.g., `src/foo.ts:42`)
98
+ - Brief description of the issue
99
+ - Reference to the PR (e.g., `(PR #123)`)
100
+
101
+ c. **Check out the PR branch:**
102
+ ```bash
103
+ gh pr checkout <PR_NUMBER> --repo $REPO
104
+ ```
105
+
106
+ d. **Fix issues systematically:**
107
+ - Mark the parent bead as in_progress: `tbd update <id> --status in_progress`
108
+ - Work through each child bead in order:
109
+ - Mark as in_progress before starting
110
+ - Follow `tbd guidelines general-tdd-guidelines` for code fixes
111
+ - Run tests after each fix
112
+ - Mark as closed when complete: `tbd close <id>`
113
+ - Commit fixes with conventional commit messages
114
+
115
+ e. **Verify CI passes:**
116
+ - Push changes: `git push`
117
+ - Wait for CI: `gh pr checks <PR_NUMBER> --repo $REPO --watch 2>&1`
118
+ - **IMPORTANT**: Wait for the final summary—don’t stop at early “passing” output
119
+ - If CI fails: create a bead for the failure, fix it, restart this step
120
+
121
+ f. **Update PR description** to reflect what was fixed:
122
+ ```bash
123
+ gh pr edit <PR_NUMBER> --repo $REPO --body "..."
124
+ ```
125
+
126
+ g. **Close the parent bead:**
127
+ ```bash
128
+ tbd close <parent-bead-id> --reason "PR review complete, all issues resolved"
129
+ tbd sync
130
+ ```
54
131
 
55
- - **If adding as comment:**
56
- ```bash
57
- gh pr review <PR_NUMBER> --repo $REPO --comment --body "<review>"
58
- ```
132
+ ### If report only:
59
133
 
60
- - **If creating fix beads:**
61
- - Create a bead for each issue: `tbd create "Fix: ..." --type bug`
62
- - Check out the PR branch if not already on it:
63
- `gh pr checkout <PR_NUMBER> --repo $REPO`
64
- - Follow `tbd shortcut implement-beads` to fix issues
65
- - Push changes and update the PR
134
+ - Output the review
135
+ - No further action needed
66
136
 
67
- - **If report only:**
68
- - Output the review
69
- - No further action needed
137
+ 10. **Report to user:**
138
+ - Summarize what was reviewed (and fixed, if applicable)
139
+ - List any beads created (if fixing with beads)
140
+ - Confirm CI status
141
+ - Provide the PR URL
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Revise All Architecture Docs
3
3
  description: Comprehensive revision of all current architecture documents
4
+ category: documentation
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  We track work as beads using tbd.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Revise Architecture Doc
3
3
  description: Update an architecture document to reflect current codebase state
4
+ category: documentation
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  Review and update an architecture document to ensure accuracy with current code.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Setup GitHub CLI
3
3
  description: Ensure GitHub CLI (gh) is installed and working
4
+ category: session
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  The GitHub CLI (`gh`) is required for PR and issue operations.
@@ -1,16 +1,13 @@
1
1
  ---
2
2
  title: Sync Failure Recovery
3
3
  description: Handle tbd sync failures by saving to workspace and recovering later
4
+ category: session
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  When `tbd sync` fails to push (e.g., network errors, permission issues, branch
7
8
  restrictions), use this workflow to preserve and recover issue data.
8
9
 
9
- ## Workflow
10
-
11
- ### 1. When sync fails
12
-
13
- If `tbd sync` fails with a push error:
10
+ ## When Sync Fails
14
11
 
15
12
  ```bash
16
13
  # Save unsynced changes to the outbox
@@ -22,9 +19,7 @@ git commit -m "tbd: save outbox"
22
19
  git push
23
20
  ```
24
21
 
25
- The `--outbox` flag saves only issues modified since the last successful sync.
26
-
27
- ### 2. Later, when sync works
22
+ ## Later, When Sync Works
28
23
 
29
24
  In a new session or environment where sync works:
30
25
 
@@ -36,52 +31,10 @@ tbd import --outbox
36
31
  tbd sync
37
32
  ```
38
33
 
39
- ## Understanding Workspaces
40
-
41
- Workspaces are directories under `.tbd/workspaces/` that store issue backups.
42
-
43
- - `tbd save --outbox` saves to `.tbd/workspaces/outbox/`
44
- - `tbd import --outbox` imports from outbox and clears it on success
45
- - Workspaces are committed to your working branch (not gitignored)
34
+ ## More Information
46
35
 
47
- ## Alternative: Named Workspaces
48
-
49
- For backups or bulk editing, use named workspaces:
36
+ For detailed troubleshooting, workspace usage, and diagnostic commands, see:
50
37
 
51
38
  ```bash
52
- # Create a backup
53
- tbd save --workspace=backup-2026-01
54
-
55
- # Save to arbitrary directory
56
- tbd save --dir=/tmp/issues-backup
57
-
58
- # Import from named workspace
59
- tbd import --workspace=backup-2026-01
39
+ tbd guidelines sync-troubleshooting
60
40
  ```
61
-
62
- ## Checking Workspace Status
63
-
64
- ```bash
65
- # List all workspaces
66
- tbd workspace list
67
-
68
- # See workspaces in tbd status output
69
- tbd status
70
- ```
71
-
72
- ## Multi-Agent Scenarios
73
-
74
- Multiple agents can save to the same outbox:
75
-
76
- - Different issues: No conflicts, all preserved
77
- - Same issue edited compatibly: Merged automatically
78
- - Same issue with conflicts: Conflict goes to attic for review
79
-
80
- ## Troubleshooting
81
-
82
- If sync continues to fail:
83
-
84
- 1. Check network connectivity
85
- 2. Verify push permissions: `git push --dry-run origin tbd-sync`
86
- 3. Check for branch restrictions in your environment
87
- 4. Review error message from `tbd sync` for specific guidance
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Update Specs Status
3
3
  description: Review active specs and sync their status with tbd issues
4
+ category: planning
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  Review all active specs and ensure tbd issues accurately reflect current progress.
@@ -1,6 +1,7 @@
1
1
  ---
2
2
  title: Welcome User
3
3
  description: Welcome message for users after tbd installation or setup
4
+ category: session
4
5
  author: Joshua Levy (github.com/jlevy) with LLM assistance
5
6
  ---
6
7
  Welcome the user with the message below.
@@ -38,7 +39,7 @@ Here are examples of things you can say and what happens:
38
39
  | "Let's plan a new feature" | Walks you through creating a planning spec (`tbd shortcut new-plan-spec`) |
39
40
  | "Break the spec into issues" | Creates implementation beads from your spec (`tbd shortcut plan-implementation-with-beads`) |
40
41
  | "Implement these issues" | Works through beads systematically (`tbd shortcut implement-beads`) |
41
- | "Commit this code" | Reviews changes and commits properly (`tbd shortcut commit-code`) |
42
+ | "Commit this code" | Reviews changes and commits properly (`tbd shortcut code-review-and-commit`) |
42
43
  | "Create a PR" | Creates a pull request with summary (`tbd shortcut create-or-update-pr-simple`) |
43
44
  | "Review this for best practices" | Performs a code review with guidelines |
44
45
 
@@ -27,7 +27,7 @@ tbd sync # Sync with remote
27
27
  | --- | --- |
28
28
  | Found a bug | `tbd create "..." --type=bug` |
29
29
  | Plan a feature | `tbd shortcut new-plan-spec` |
30
- | Commit code | `tbd shortcut commit-code` |
30
+ | Commit code | `tbd shortcut code-review-and-commit` |
31
31
  | Create a PR | `tbd shortcut create-or-update-pr-simple` |
32
32
  | TypeScript review | `tbd guidelines typescript-rules` |
33
33
 
@@ -6,16 +6,19 @@ description: Full tbd workflow guide for agents
6
6
 
7
7
  1. **Beads**: Git-native issue tracking (tasks, bugs, features).
8
8
  Never lose work across sessions.
9
+ Drop-in replacement for `bd`.
9
10
  2. **Spec-Driven Workflows**: Plan features → break into beads → implement
10
11
  systematically.
11
- 3. **Shortcuts**: Reusable instruction templates for common workflows.
12
- 4. **Guidelines**: Coding rules and best practices.
12
+ 3. **Knowledge Injection**: 17+ engineering guidelines (TypeScript, Python, TDD,
13
+ testing, Convex, monorepos) available on demand.
14
+ 4. **Shortcuts**: Reusable instruction templates for common workflows (code review,
15
+ commits, PRs, cleanup, handoffs).
13
16
 
14
17
  ## Installation
15
18
 
16
19
  ```bash
17
20
  npm install -g get-tbd@latest
18
- tbd setup --auto --prefix=<name> # Fresh project (--prefix is REQUIRED and should be short. For new project setup, ALWAYS ASK THE USER FOR THE PREFIX; do not guess it)
21
+ tbd setup --auto --prefix=<name> # Fresh project (--prefix is REQUIRED: 2-8 alphabetic chars recommended. ALWAYS ASK THE USER FOR THE PREFIX; do not guess it)
19
22
  tbd setup --auto # Existing tbd project (prefix already set)
20
23
  tbd setup --from-beads # Migration from .beads/ if `bd` has been used
21
24
  ```
@@ -48,20 +51,42 @@ or want help → run `tbd shortcut welcome-user`
48
51
 
49
52
  | User Says | You (the Agent) Run |
50
53
  | --- | --- |
54
+ | **Issues/Beads** | |
51
55
  | "There's a bug where ..." | `tbd create "..." --type=bug` |
52
- | "Let's work on issues" | `tbd ready` |
53
- | "Build a TypeScript CLI" | `tbd guidelines typescript-cli-tool-rules` |
54
- | "Improve eslint/monorepo" | `tbd guidelines typescript-monorepo-patterns` |
55
- | "Add e2e/golden testing" | `tbd guidelines golden-testing-guidelines` |
56
- | "Review changes" (TS) | `tbd guidelines typescript-rules` |
57
- | "Review changes" (Python) | `tbd guidelines python-rules` |
58
- | "Plan a new feature" | `tbd shortcut new-plan-spec` |
56
+ | "Create a task/feature for ..." | `tbd create "..." --type=task` or `--type=feature` |
57
+ | "Let's work on issues/beads" | `tbd ready` |
58
+ | "Show me issue X" | `tbd show <id>` |
59
+ | "Close this issue" | `tbd close <id>` |
60
+ | "Search issues for X" | `tbd search "X"` |
61
+ | "Add label X to issue" | `tbd label add <id> <label>` |
62
+ | "What issues are stale?" | `tbd stale` |
63
+ | **Planning & Specs** | |
64
+ | "Plan a new feature" / "Create a spec" | `tbd shortcut new-plan-spec` |
59
65
  | "Break spec into beads" | `tbd shortcut plan-implementation-with-beads` |
60
66
  | "Implement these beads" | `tbd shortcut implement-beads` |
61
- | "Commit this" | `tbd shortcut commit-code` |
62
- | "Create a PR" | `tbd shortcut create-or-update-pr-simple` |
67
+ | **Code Review & Commits** | |
68
+ | "Review this code" / "Code review" | `tbd shortcut review-code` |
69
+ | "Review this PR" | `tbd shortcut review-github-pr` |
70
+ | "Commit this" / "Use the commit shortcut" | `tbd shortcut code-review-and-commit` |
71
+ | "Create a PR" / "File a PR" | `tbd shortcut create-or-update-pr-simple` |
72
+ | "Merge main into my branch" | `tbd shortcut merge-upstream` |
73
+ | **Guidelines & Knowledge** | |
74
+ | "Use TypeScript best practices" | `tbd guidelines typescript-rules` |
75
+ | "Use Python best practices" | `tbd guidelines python-rules` |
76
+ | "Build a TypeScript CLI" | `tbd guidelines typescript-cli-tool-rules` |
77
+ | "Improve monorepo setup" | `tbd guidelines pnpm-monorepo-patterns` or `bun-monorepo-patterns` |
78
+ | "Add golden/e2e testing" | `tbd guidelines golden-testing-guidelines` |
79
+ | "Use TDD" / "Test-driven development" | `tbd guidelines general-tdd-guidelines` |
80
+ | "Convex best practices" | `tbd guidelines convex-rules` |
81
+ | **Documentation** | |
63
82
  | "Research this topic" | `tbd shortcut new-research-brief` |
64
83
  | "Document architecture" | `tbd shortcut new-architecture-doc` |
84
+ | **Cleanup & Maintenance** | |
85
+ | "Clean up this code" / "Remove dead code" | `tbd shortcut code-cleanup-all` |
86
+ | "Fix repository problems" | `tbd doctor --fix` |
87
+ | **Sessions & Handoffs** | |
88
+ | "Hand off to another agent" | `tbd shortcut agent-handoff` |
89
+ | "Check out this library's source" | `tbd shortcut checkout-third-party-repo` |
65
90
  | *(your choice whenever appropriate)* | `tbd list`, `tbd dep add`, `tbd close`, `tbd sync`, etc. |
66
91
 
67
92
  ## CRITICAL: Session Closing Protocol
@@ -115,6 +140,17 @@ or want help → run `tbd shortcut welcome-user`
115
140
  | `tbd sync` | Sync with git remote (run at session end) |
116
141
  | `tbd stats` | Project statistics |
117
142
  | `tbd doctor` | Check for problems |
143
+ | `tbd doctor --fix` | Auto-fix repository problems |
144
+
145
+ ### Labels & Search
146
+
147
+ | Command | Purpose |
148
+ | --- | --- |
149
+ | `tbd search <query>` | Search issues by text |
150
+ | `tbd label add <id> <label>` | Add label to issue |
151
+ | `tbd label remove <id> <label>` | Remove label from issue |
152
+ | `tbd label list` | List all labels in use |
153
+ | `tbd stale` | List issues not updated recently |
118
154
 
119
155
  ### Documentation
120
156
 
@@ -27,7 +27,7 @@ tbd sync # Sync with remote
27
27
  | --- | --- |
28
28
  | Found a bug | `tbd create "..." --type=bug` |
29
29
  | Plan a feature | `tbd shortcut new-plan-spec` |
30
- | Commit code | `tbd shortcut commit-code` |
30
+ | Commit code | `tbd shortcut code-review-and-commit` |
31
31
  | Create a PR | `tbd shortcut create-or-update-pr-simple` |
32
32
  | TypeScript review | `tbd guidelines typescript-rules` |
33
33