get-tbd 0.1.8
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.
- package/README.md +508 -0
- package/dist/bin-bootstrap.cjs +25 -0
- package/dist/bin-bootstrap.cjs.map +1 -0
- package/dist/bin.d.mts +2 -0
- package/dist/bin.mjs +106320 -0
- package/dist/bin.mjs.map +1 -0
- package/dist/cli.d.mts +13 -0
- package/dist/cli.mjs +9711 -0
- package/dist/cli.mjs.map +1 -0
- package/dist/docs/README.md +508 -0
- package/dist/docs/SKILL.md +222 -0
- package/dist/docs/guidelines/backward-compatibility-rules.md +78 -0
- package/dist/docs/guidelines/commit-conventions.md +78 -0
- package/dist/docs/guidelines/convex-limits-best-practices.md +170 -0
- package/dist/docs/guidelines/convex-rules.md +942 -0
- package/dist/docs/guidelines/general-coding-rules.md +36 -0
- package/dist/docs/guidelines/general-comment-rules.md +45 -0
- package/dist/docs/guidelines/general-eng-assistant-rules.md +54 -0
- package/dist/docs/guidelines/general-style-rules.md +37 -0
- package/dist/docs/guidelines/general-tdd-guidelines.md +52 -0
- package/dist/docs/guidelines/general-testing-rules.md +26 -0
- package/dist/docs/guidelines/golden-testing-guidelines.md +72 -0
- package/dist/docs/guidelines/python-cli-patterns.md +84 -0
- package/dist/docs/guidelines/python-rules.md +60 -0
- package/dist/docs/guidelines/typescript-cli-tool-rules.md +346 -0
- package/dist/docs/guidelines/typescript-code-coverage.md +171 -0
- package/dist/docs/guidelines/typescript-monorepo-patterns.md +71 -0
- package/dist/docs/guidelines/typescript-rules.md +55 -0
- package/dist/docs/install/claude-header.md +12 -0
- package/dist/docs/install/ensure-gh-cli.sh +88 -0
- package/dist/docs/shortcuts/standard/commit-code.md +23 -0
- package/dist/docs/shortcuts/standard/create-or-update-pr-simple.md +29 -0
- package/dist/docs/shortcuts/standard/create-or-update-pr-with-validation-plan.md +48 -0
- package/dist/docs/shortcuts/standard/implement-beads.md +31 -0
- package/dist/docs/shortcuts/standard/new-architecture-doc.md +31 -0
- package/dist/docs/shortcuts/standard/new-implementation-beads-from-spec.md +28 -0
- package/dist/docs/shortcuts/standard/new-plan-spec.md +49 -0
- package/dist/docs/shortcuts/standard/new-research-brief.md +30 -0
- package/dist/docs/shortcuts/standard/new-validation-plan.md +51 -0
- package/dist/docs/shortcuts/standard/precommit-process.md +88 -0
- package/dist/docs/shortcuts/standard/review-code-python.md +47 -0
- package/dist/docs/shortcuts/standard/review-code-typescript.md +46 -0
- package/dist/docs/shortcuts/standard/welcome-user.md +65 -0
- package/dist/docs/shortcuts/system/shortcut-explanation.md +61 -0
- package/dist/docs/shortcuts/system/skill-brief.md +40 -0
- package/dist/docs/shortcuts/system/skill.md +210 -0
- package/dist/docs/skill-brief.md +40 -0
- package/dist/docs/tbd-closing.md +31 -0
- package/dist/docs/tbd-design.md +5308 -0
- package/dist/docs/tbd-docs.md +1113 -0
- package/dist/docs/tbd-prime.md +119 -0
- package/dist/docs/templates/architecture-doc.md +117 -0
- package/dist/docs/templates/plan-spec.md +69 -0
- package/dist/docs/templates/research-brief.md +71 -0
- package/dist/index.d.mts +567 -0
- package/dist/index.mjs +3 -0
- package/dist/src-CWD4YCBk.mjs +319 -0
- package/dist/src-CWD4YCBk.mjs.map +1 -0
- package/dist/tbd +106320 -0
- package/package.json +92 -0
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# tbd Workflow Context
|
|
2
|
+
|
|
3
|
+
> **Context Recovery**: Run `tbd prime` after compaction, clear, or new session.
|
|
4
|
+
> Hooks auto-call this in Claude Code when .tbd/ detected.
|
|
5
|
+
|
|
6
|
+
# SESSION CLOSE PROTOCOL
|
|
7
|
+
|
|
8
|
+
**CRITICAL**: Before saying “done” or “complete”, you MUST run this checklist:
|
|
9
|
+
|
|
10
|
+
```
|
|
11
|
+
[ ] 1. Stage and commit: git add + git commit
|
|
12
|
+
[ ] 2. Push to remote: git push
|
|
13
|
+
[ ] 3. Start CI watch (BLOCKS until done): gh pr checks <PR> --watch 2>&1
|
|
14
|
+
[ ] 4. While CI runs: tbd close/update <id> for issues worked on
|
|
15
|
+
[ ] 5. While CI runs: tbd sync
|
|
16
|
+
[ ] 6. Return to step 3 and CONFIRM CI passed
|
|
17
|
+
[ ] 7. If CI failed: fix, re-push, restart from step 3
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## NON-NEGOTIABLE Requirements
|
|
21
|
+
|
|
22
|
+
### CI: Wait for `--watch` to finish
|
|
23
|
+
|
|
24
|
+
The `--watch` flag blocks until ALL checks complete.
|
|
25
|
+
Do NOT see “passing” in early output and move on—wait for the **final summary** showing
|
|
26
|
+
all checks passed.
|
|
27
|
+
|
|
28
|
+
### tbd: Update issues and sync
|
|
29
|
+
|
|
30
|
+
Every session must end with tbd in a clean state:
|
|
31
|
+
- Close/update **every issue** you worked on
|
|
32
|
+
- Run `tbd sync` and confirm it completed
|
|
33
|
+
|
|
34
|
+
**Work is not done until pushed, CI passes, and tbd is synced.**
|
|
35
|
+
|
|
36
|
+
## Core Rules
|
|
37
|
+
|
|
38
|
+
- Track *all task work* not being done immediately as beads using `tbd` (discovered
|
|
39
|
+
work, future work, TODOs for the session, multi-session work)
|
|
40
|
+
- When in doubt, prefer tbd for tracking tasks, bugs, and issues
|
|
41
|
+
- Use `tbd create` for creating beads
|
|
42
|
+
- Git workflow: update or close issues and run `tbd sync` at session end
|
|
43
|
+
- If not given specific directions, check `tbd ready` for available work
|
|
44
|
+
|
|
45
|
+
## Essential Commands
|
|
46
|
+
|
|
47
|
+
### Finding Work
|
|
48
|
+
|
|
49
|
+
- `tbd ready` - Show issues ready to work (no blockers)
|
|
50
|
+
- `tbd list --status open` - All open issues
|
|
51
|
+
- `tbd list --status in_progress` - Your active work
|
|
52
|
+
- `tbd show <id>` - Detailed issue view with dependencies
|
|
53
|
+
|
|
54
|
+
### Creating & Updating
|
|
55
|
+
|
|
56
|
+
- `tbd create "title" --type task|bug|feature --priority 2` - New issue
|
|
57
|
+
- Priority: 0-4 (0=critical, 2=medium, 4=backlog).
|
|
58
|
+
Do NOT use "high"/"medium"/"low"
|
|
59
|
+
- `tbd update <id> --status in_progress` - Claim work
|
|
60
|
+
- `tbd update <id> --assignee username` - Assign to someone
|
|
61
|
+
- `tbd close <id>` - Mark complete
|
|
62
|
+
- `tbd close <id> --reason "explanation"` - Close with reason
|
|
63
|
+
- **Tip**: When creating multiple issues, use parallel subagents for efficiency
|
|
64
|
+
|
|
65
|
+
### Dependencies & Blocking
|
|
66
|
+
|
|
67
|
+
- `tbd dep add <issue> <depends-on>` - Add dependency (issue depends on depends-on)
|
|
68
|
+
- `tbd blocked` - Show all blocked issues
|
|
69
|
+
- `tbd show <id>` - See what’s blocking/blocked by this issue
|
|
70
|
+
|
|
71
|
+
### Sync & Collaboration
|
|
72
|
+
|
|
73
|
+
- `tbd sync` - Sync with git remote (run at session end)
|
|
74
|
+
- `tbd sync --status` - Check sync status without syncing
|
|
75
|
+
|
|
76
|
+
Note: `tbd sync` handles all git operations for issues--no manual git push needed.
|
|
77
|
+
|
|
78
|
+
### Project Health
|
|
79
|
+
|
|
80
|
+
- `tbd stats` - Project statistics (open/closed/blocked counts)
|
|
81
|
+
- `tbd doctor` - Check for issues (sync problems, missing hooks)
|
|
82
|
+
|
|
83
|
+
## Common Workflows
|
|
84
|
+
|
|
85
|
+
**Starting work:**
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
tbd ready # Find available work
|
|
89
|
+
tbd show <id> # Review issue details
|
|
90
|
+
tbd update <id> --status in_progress # Claim it
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
**Completing work:**
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
tbd close <id> # Mark complete
|
|
97
|
+
tbd sync # Push to remote
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
**Creating dependent work:**
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
tbd create "Implement feature X" --type feature
|
|
104
|
+
tbd create "Write tests for X" --type task
|
|
105
|
+
tbd dep add <tests-id> <feature-id> # Tests depend on feature
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Setup Commands
|
|
109
|
+
|
|
110
|
+
- `tbd setup --auto` - Non-interactive setup with smart defaults (for agents/scripts)
|
|
111
|
+
- `tbd setup --interactive` - Interactive setup with prompts (for humans)
|
|
112
|
+
- `tbd setup --from-beads` - Migrate from Beads to tbd
|
|
113
|
+
|
|
114
|
+
## Quick Reference
|
|
115
|
+
|
|
116
|
+
- **Priority levels**: 0=critical, 1=high, 2=medium (default), 3=low, 4=backlog
|
|
117
|
+
- **Issue types**: task, bug, feature, epic
|
|
118
|
+
- **Status values**: open, in_progress, closed
|
|
119
|
+
- **JSON output**: Add `--json` to any command for machine-readable output
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Architecture Doc Template
|
|
3
|
+
description: Template for architecture documents
|
|
4
|
+
---
|
|
5
|
+
# Architecture: [Component/System Name]
|
|
6
|
+
|
|
7
|
+
**Date:** YYYY-MM-DD **Author:** [Name] **Status:** Draft | In Review | Approved
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
High-level description of what this architecture covers.
|
|
12
|
+
|
|
13
|
+
## Goals and Non-Goals
|
|
14
|
+
|
|
15
|
+
### Goals
|
|
16
|
+
|
|
17
|
+
- Goal 1
|
|
18
|
+
- Goal 2
|
|
19
|
+
|
|
20
|
+
### Non-Goals
|
|
21
|
+
|
|
22
|
+
- Non-goal 1
|
|
23
|
+
- Non-goal 2
|
|
24
|
+
|
|
25
|
+
## System Context
|
|
26
|
+
|
|
27
|
+
How this component fits into the larger system.
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
[Diagram placeholder - describe the system context]
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Design
|
|
34
|
+
|
|
35
|
+
### Components
|
|
36
|
+
|
|
37
|
+
#### Component 1
|
|
38
|
+
|
|
39
|
+
**Responsibility:** What this component does.
|
|
40
|
+
|
|
41
|
+
**Interfaces:** How other components interact with it.
|
|
42
|
+
|
|
43
|
+
#### Component 2
|
|
44
|
+
|
|
45
|
+
**Responsibility:** What this component does.
|
|
46
|
+
|
|
47
|
+
**Interfaces:** How other components interact with it.
|
|
48
|
+
|
|
49
|
+
### Data Flow
|
|
50
|
+
|
|
51
|
+
How data moves through the system.
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
[Diagram placeholder - describe the data flow]
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Data Model
|
|
58
|
+
|
|
59
|
+
Key data structures and their relationships.
|
|
60
|
+
|
|
61
|
+
### Interfaces
|
|
62
|
+
|
|
63
|
+
#### External APIs
|
|
64
|
+
|
|
65
|
+
| Endpoint | Method | Description |
|
|
66
|
+
| --- | --- | --- |
|
|
67
|
+
| `/api/example` | GET | Description |
|
|
68
|
+
|
|
69
|
+
#### Internal Interfaces
|
|
70
|
+
|
|
71
|
+
Key internal contracts between components.
|
|
72
|
+
|
|
73
|
+
## Trade-offs and Alternatives
|
|
74
|
+
|
|
75
|
+
### Decision 1: [Description]
|
|
76
|
+
|
|
77
|
+
**Chosen approach:** What we decided.
|
|
78
|
+
|
|
79
|
+
**Alternatives considered:**
|
|
80
|
+
- Alternative A: Why rejected
|
|
81
|
+
- Alternative B: Why rejected
|
|
82
|
+
|
|
83
|
+
**Rationale:** Why we chose this approach.
|
|
84
|
+
|
|
85
|
+
## Security Considerations
|
|
86
|
+
|
|
87
|
+
- Authentication approach
|
|
88
|
+
- Authorization model
|
|
89
|
+
- Data protection measures
|
|
90
|
+
|
|
91
|
+
## Operational Concerns
|
|
92
|
+
|
|
93
|
+
### Monitoring
|
|
94
|
+
|
|
95
|
+
What metrics and alerts are needed.
|
|
96
|
+
|
|
97
|
+
### Logging
|
|
98
|
+
|
|
99
|
+
What should be logged and at what level.
|
|
100
|
+
|
|
101
|
+
### Deployment
|
|
102
|
+
|
|
103
|
+
How this component is deployed.
|
|
104
|
+
|
|
105
|
+
### Scaling
|
|
106
|
+
|
|
107
|
+
How this component scales under load.
|
|
108
|
+
|
|
109
|
+
## Open Questions
|
|
110
|
+
|
|
111
|
+
- Question 1?
|
|
112
|
+
- Question 2?
|
|
113
|
+
|
|
114
|
+
## References
|
|
115
|
+
|
|
116
|
+
- [Related doc](url)
|
|
117
|
+
- [External reference](url)
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Plan Spec Template
|
|
3
|
+
description: Template for feature planning specification documents
|
|
4
|
+
---
|
|
5
|
+
# Feature: [Feature Name]
|
|
6
|
+
|
|
7
|
+
**Date:** YYYY-MM-DD **Author:** [Name] **Status:** Draft | In Review | Approved |
|
|
8
|
+
Implemented
|
|
9
|
+
|
|
10
|
+
## Overview
|
|
11
|
+
|
|
12
|
+
Brief description of the feature and its purpose.
|
|
13
|
+
|
|
14
|
+
## Goals
|
|
15
|
+
|
|
16
|
+
- Goal 1
|
|
17
|
+
- Goal 2
|
|
18
|
+
|
|
19
|
+
## Non-Goals
|
|
20
|
+
|
|
21
|
+
- What this feature explicitly does NOT cover
|
|
22
|
+
|
|
23
|
+
## Background
|
|
24
|
+
|
|
25
|
+
Context and motivation for this feature.
|
|
26
|
+
|
|
27
|
+
## Design
|
|
28
|
+
|
|
29
|
+
### Approach
|
|
30
|
+
|
|
31
|
+
High-level approach to implementing this feature.
|
|
32
|
+
|
|
33
|
+
### Components
|
|
34
|
+
|
|
35
|
+
Key components or modules involved.
|
|
36
|
+
|
|
37
|
+
### API Changes
|
|
38
|
+
|
|
39
|
+
Any API additions or modifications.
|
|
40
|
+
|
|
41
|
+
## Implementation Plan
|
|
42
|
+
|
|
43
|
+
### Phase 1: [Name]
|
|
44
|
+
|
|
45
|
+
- [ ] Task 1
|
|
46
|
+
- [ ] Task 2
|
|
47
|
+
|
|
48
|
+
### Phase 2: [Name] (if needed)
|
|
49
|
+
|
|
50
|
+
- [ ] Task 3
|
|
51
|
+
- [ ] Task 4
|
|
52
|
+
|
|
53
|
+
## Testing Strategy
|
|
54
|
+
|
|
55
|
+
How will this feature be tested?
|
|
56
|
+
|
|
57
|
+
## Rollout Plan
|
|
58
|
+
|
|
59
|
+
How will this feature be deployed?
|
|
60
|
+
|
|
61
|
+
## Open Questions
|
|
62
|
+
|
|
63
|
+
- Question 1?
|
|
64
|
+
- Question 2?
|
|
65
|
+
|
|
66
|
+
## References
|
|
67
|
+
|
|
68
|
+
- Link to related docs
|
|
69
|
+
- Link to related issues
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Research Brief Template
|
|
3
|
+
description: Template for research documents
|
|
4
|
+
---
|
|
5
|
+
# Research: [Topic]
|
|
6
|
+
|
|
7
|
+
**Date:** YYYY-MM-DD **Author:** [Name] **Status:** In Progress | Complete
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
What we’re researching and why.
|
|
12
|
+
|
|
13
|
+
## Questions to Answer
|
|
14
|
+
|
|
15
|
+
1. Question 1?
|
|
16
|
+
2. Question 2?
|
|
17
|
+
3. Question 3?
|
|
18
|
+
|
|
19
|
+
## Scope
|
|
20
|
+
|
|
21
|
+
What’s included and excluded from this research.
|
|
22
|
+
|
|
23
|
+
## Findings
|
|
24
|
+
|
|
25
|
+
### [Subtopic 1]
|
|
26
|
+
|
|
27
|
+
Key findings here.
|
|
28
|
+
|
|
29
|
+
### [Subtopic 2]
|
|
30
|
+
|
|
31
|
+
Key findings here.
|
|
32
|
+
|
|
33
|
+
## Options Considered
|
|
34
|
+
|
|
35
|
+
### Option A: [Name]
|
|
36
|
+
|
|
37
|
+
**Description:** What this option involves.
|
|
38
|
+
|
|
39
|
+
**Pros:**
|
|
40
|
+
- Pro 1
|
|
41
|
+
- Pro 2
|
|
42
|
+
|
|
43
|
+
**Cons:**
|
|
44
|
+
- Con 1
|
|
45
|
+
- Con 2
|
|
46
|
+
|
|
47
|
+
### Option B: [Name]
|
|
48
|
+
|
|
49
|
+
**Description:** What this option involves.
|
|
50
|
+
|
|
51
|
+
**Pros:**
|
|
52
|
+
- Pro 1
|
|
53
|
+
- Pro 2
|
|
54
|
+
|
|
55
|
+
**Cons:**
|
|
56
|
+
- Con 1
|
|
57
|
+
- Con 2
|
|
58
|
+
|
|
59
|
+
## Recommendations
|
|
60
|
+
|
|
61
|
+
Based on the findings, we recommend …
|
|
62
|
+
|
|
63
|
+
## Next Steps
|
|
64
|
+
|
|
65
|
+
- [ ] Action item 1
|
|
66
|
+
- [ ] Action item 2
|
|
67
|
+
|
|
68
|
+
## References
|
|
69
|
+
|
|
70
|
+
- [Link 1](url)
|
|
71
|
+
- [Link 2](url)
|