forge-workflow 1.0.0 → 1.1.1
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/.claude/commands/status.md +1 -1
- package/.claude/settings.local.json +14 -0
- package/AGENTS.md +217 -0
- package/README.md +786 -131
- package/bin/forge.js +1846 -115
- package/docs/TOOLCHAIN.md +760 -0
- package/install.sh +1036 -62
- package/package.json +22 -9
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
{
|
|
2
|
+
"permissions": {
|
|
3
|
+
"allow": [
|
|
4
|
+
"Bash(npm view:*)",
|
|
5
|
+
"Bash(npm publish:*)",
|
|
6
|
+
"Bash(npm whoami:*)",
|
|
7
|
+
"Bash(npm:*)",
|
|
8
|
+
"Bash(cmd /c \"npm publish --access public\")",
|
|
9
|
+
"Bash(where npm)",
|
|
10
|
+
"Bash(\"C:\\\\Program Files\\\\nodejs\\\\npm.cmd\" publish --access public)",
|
|
11
|
+
"Bash(\"C:\\\\Program Files\\\\nodejs\\\\npm.cmd\" version patch --no-git-tag-version)"
|
|
12
|
+
]
|
|
13
|
+
}
|
|
14
|
+
}
|
package/AGENTS.md
ADDED
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
# Forge - 9-Stage TDD Workflow
|
|
2
|
+
|
|
3
|
+
A TDD-first workflow for AI coding agents. Ship features with confidence.
|
|
4
|
+
|
|
5
|
+
## Commands (9 Stages)
|
|
6
|
+
|
|
7
|
+
| Stage | Command | Description |
|
|
8
|
+
|-------|---------|-------------|
|
|
9
|
+
| 1 | `/status` | Check current context, active work, recent completions |
|
|
10
|
+
| 2 | `/research` | Deep research with web search, document to docs/research/ |
|
|
11
|
+
| 3 | `/plan` | Create implementation plan, branch, OpenSpec if strategic |
|
|
12
|
+
| 4 | `/dev` | TDD development (RED-GREEN-REFACTOR cycles) |
|
|
13
|
+
| 5 | `/check` | Validation (type/lint/security/tests) |
|
|
14
|
+
| 6 | `/ship` | Create PR with full documentation |
|
|
15
|
+
| 7 | `/review` | Address ALL PR feedback |
|
|
16
|
+
| 8 | `/merge` | Update docs, merge PR, cleanup |
|
|
17
|
+
| 9 | `/verify` | Final documentation verification |
|
|
18
|
+
|
|
19
|
+
## Workflow Flow
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
/status → /research → /plan → /dev → /check → /ship → /review → /merge → /verify
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Core Principles
|
|
26
|
+
|
|
27
|
+
- **TDD-First**: Write tests BEFORE implementation (RED-GREEN-REFACTOR)
|
|
28
|
+
- **Research-First**: Understand before building, document decisions
|
|
29
|
+
- **Security Built-In**: OWASP Top 10 analysis for every feature
|
|
30
|
+
- **Documentation Progressive**: Update at each stage, verify at end
|
|
31
|
+
|
|
32
|
+
## Prerequisites
|
|
33
|
+
|
|
34
|
+
- Git, GitHub CLI (`gh`)
|
|
35
|
+
- Beads (recommended): `npm i -g @beads/bd && bd init`
|
|
36
|
+
- OpenSpec (optional): `npm i -g @fission-ai/openspec && openspec init`
|
|
37
|
+
|
|
38
|
+
## Toolchain Quick Reference
|
|
39
|
+
|
|
40
|
+
### Beads (Issue Tracking)
|
|
41
|
+
```bash
|
|
42
|
+
bd ready # Find unblocked work (start here!)
|
|
43
|
+
bd create "Title" -p 2 # Create issue with priority
|
|
44
|
+
bd update <id> --status in_progress
|
|
45
|
+
bd comments <id> "note" # Add comment
|
|
46
|
+
bd close <id> # Complete
|
|
47
|
+
bd sync # Git sync (always at session end!)
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### OpenSpec (Specs - AI Commands)
|
|
51
|
+
```bash
|
|
52
|
+
/opsx:new # Start change
|
|
53
|
+
/opsx:ff # Generate all planning docs
|
|
54
|
+
/opsx:apply # Implement tasks
|
|
55
|
+
/opsx:verify # Validate
|
|
56
|
+
/opsx:archive # Complete
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### GitHub CLI
|
|
60
|
+
```bash
|
|
61
|
+
gh pr create --title "..." --body "..."
|
|
62
|
+
gh pr view <n>
|
|
63
|
+
gh pr merge <n> --squash --delete-branch
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## Quick Start
|
|
67
|
+
|
|
68
|
+
1. `/status` - Check where you are
|
|
69
|
+
2. `/research <feature-name>` - Research the feature
|
|
70
|
+
3. `/plan <feature-slug>` - Create formal plan
|
|
71
|
+
4. `/dev` - Implement with TDD
|
|
72
|
+
5. `/check` - Validate everything
|
|
73
|
+
6. `/ship` - Create PR
|
|
74
|
+
|
|
75
|
+
## Stage Details
|
|
76
|
+
|
|
77
|
+
### 1. Status (`/status`)
|
|
78
|
+
|
|
79
|
+
Check current context before starting work:
|
|
80
|
+
- Active issues (via Beads if installed)
|
|
81
|
+
- Recent completions
|
|
82
|
+
- Current branch state
|
|
83
|
+
- OpenSpec proposals in progress
|
|
84
|
+
|
|
85
|
+
### 2. Research (`/research <feature-name>`)
|
|
86
|
+
|
|
87
|
+
Research before building:
|
|
88
|
+
- Web search for best practices
|
|
89
|
+
- Security analysis (OWASP Top 10)
|
|
90
|
+
- Existing patterns in codebase
|
|
91
|
+
- Document to `docs/research/<feature>.md`
|
|
92
|
+
|
|
93
|
+
### 3. Plan (`/plan <feature-slug>`)
|
|
94
|
+
|
|
95
|
+
Create implementation plan:
|
|
96
|
+
- Create feature branch
|
|
97
|
+
- Define scope and approach
|
|
98
|
+
- Create tracking issue (Beads)
|
|
99
|
+
- OpenSpec proposal if strategic
|
|
100
|
+
|
|
101
|
+
### 4. Development (`/dev`)
|
|
102
|
+
|
|
103
|
+
TDD implementation:
|
|
104
|
+
- RED: Write failing test
|
|
105
|
+
- GREEN: Make it pass
|
|
106
|
+
- REFACTOR: Clean up
|
|
107
|
+
- Commit after each GREEN cycle
|
|
108
|
+
|
|
109
|
+
### 5. Check (`/check`)
|
|
110
|
+
|
|
111
|
+
Validate everything:
|
|
112
|
+
- Type checking
|
|
113
|
+
- Linting
|
|
114
|
+
- Unit tests
|
|
115
|
+
- Integration tests
|
|
116
|
+
- Security scan
|
|
117
|
+
|
|
118
|
+
### 6. Ship (`/ship`)
|
|
119
|
+
|
|
120
|
+
Create pull request:
|
|
121
|
+
- Push branch
|
|
122
|
+
- Create PR with documentation
|
|
123
|
+
- Link to research doc
|
|
124
|
+
- List test coverage
|
|
125
|
+
|
|
126
|
+
### 7. Review (`/review`)
|
|
127
|
+
|
|
128
|
+
Address ALL feedback:
|
|
129
|
+
- GitHub Actions failures
|
|
130
|
+
- Code review comments
|
|
131
|
+
- Security scan issues
|
|
132
|
+
- Automated tool feedback
|
|
133
|
+
|
|
134
|
+
### 8. Merge (`/merge`)
|
|
135
|
+
|
|
136
|
+
Complete the work:
|
|
137
|
+
- Update documentation
|
|
138
|
+
- Squash merge PR
|
|
139
|
+
- Archive OpenSpec (if used)
|
|
140
|
+
- Close tracking issues
|
|
141
|
+
|
|
142
|
+
### 9. Verify (`/verify`)
|
|
143
|
+
|
|
144
|
+
Final documentation check:
|
|
145
|
+
- All docs updated
|
|
146
|
+
- Cross-references valid
|
|
147
|
+
- Examples work
|
|
148
|
+
- README current
|
|
149
|
+
|
|
150
|
+
## Directory Structure
|
|
151
|
+
|
|
152
|
+
```
|
|
153
|
+
your-project/
|
|
154
|
+
├── AGENTS.md # This file (universal)
|
|
155
|
+
├── CLAUDE.md # Claude Code
|
|
156
|
+
├── GEMINI.md # Google Antigravity
|
|
157
|
+
├── .cursorrules # Cursor
|
|
158
|
+
├── .windsurfrules # Windsurf
|
|
159
|
+
├── .clinerules # Cline/Roo Code
|
|
160
|
+
├── .github/
|
|
161
|
+
│ └── copilot-instructions.md # GitHub Copilot
|
|
162
|
+
│
|
|
163
|
+
├── .claude/commands/ # Claude Code commands
|
|
164
|
+
├── .agent/workflows/ # Antigravity workflows
|
|
165
|
+
├── .cursor/rules/ # Cursor rules
|
|
166
|
+
├── .windsurf/workflows/ # Windsurf workflows
|
|
167
|
+
├── .kilocode/workflows/ # Kilo Code workflows
|
|
168
|
+
├── .opencode/commands/ # OpenCode commands
|
|
169
|
+
├── .continue/prompts/ # Continue prompts
|
|
170
|
+
├── .roo/commands/ # Roo Code commands
|
|
171
|
+
│
|
|
172
|
+
└── docs/
|
|
173
|
+
├── planning/
|
|
174
|
+
│ └── PROGRESS.md
|
|
175
|
+
├── research/
|
|
176
|
+
│ └── TEMPLATE.md
|
|
177
|
+
└── WORKFLOW.md
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
## Skills (Universal SKILL.md Format)
|
|
181
|
+
|
|
182
|
+
The `forge-workflow` skill is installed to all supporting agents:
|
|
183
|
+
- `.claude/skills/forge-workflow/SKILL.md`
|
|
184
|
+
- `.agent/skills/forge-workflow/SKILL.md` (Antigravity)
|
|
185
|
+
- `.cursor/skills/forge-workflow/SKILL.md`
|
|
186
|
+
- `.windsurf/skills/forge-workflow/SKILL.md`
|
|
187
|
+
- `.kilocode/skills/forge-workflow/SKILL.md`
|
|
188
|
+
- `.cline/skills/forge-workflow/SKILL.md`
|
|
189
|
+
- `.continue/skills/forge-workflow/SKILL.md`
|
|
190
|
+
- `.opencode/skills/forge-workflow/SKILL.md`
|
|
191
|
+
|
|
192
|
+
## Supported Agents
|
|
193
|
+
|
|
194
|
+
This workflow works with ALL major AI coding agents:
|
|
195
|
+
|
|
196
|
+
| Agent | Instructions | Commands | Skills |
|
|
197
|
+
|-------|-------------|----------|--------|
|
|
198
|
+
| Claude Code | CLAUDE.md | .claude/commands/ | .claude/skills/ |
|
|
199
|
+
| Google Antigravity | GEMINI.md | .agent/workflows/ | .agent/skills/ |
|
|
200
|
+
| Cursor | .cursorrules | .cursor/rules/ | .cursor/skills/ |
|
|
201
|
+
| Windsurf | .windsurfrules | .windsurf/workflows/ | .windsurf/skills/ |
|
|
202
|
+
| Kilo Code | AGENTS.md | .kilocode/workflows/ | .kilocode/skills/ |
|
|
203
|
+
| OpenCode | AGENTS.md | .opencode/commands/ | .opencode/skills/ |
|
|
204
|
+
| Cline | .clinerules | AGENTS.md | .cline/skills/ |
|
|
205
|
+
| Roo Code | .clinerules | .roo/commands/ | - |
|
|
206
|
+
| Continue | .continuerules | .continue/prompts/ | .continue/skills/ |
|
|
207
|
+
| GitHub Copilot | .github/copilot-instructions.md | .github/prompts/ | - |
|
|
208
|
+
| Aider | AGENTS.md (via config) | In-chat | - |
|
|
209
|
+
|
|
210
|
+
## License
|
|
211
|
+
|
|
212
|
+
MIT
|
|
213
|
+
|
|
214
|
+
---
|
|
215
|
+
|
|
216
|
+
See `docs/WORKFLOW.md` for the complete workflow guide.
|
|
217
|
+
See `docs/TOOLCHAIN.md` for comprehensive tool reference.
|