@engramm/dev-workflow 0.1.0 → 0.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/README.md +168 -0
- package/dist/cli/index.js +0 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
# dev-workflow
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@engramm/dev-workflow)
|
|
4
|
+
[](https://github.com/supostat/dev-workflow/actions)
|
|
5
|
+
[](LICENSE)
|
|
6
|
+
|
|
7
|
+
**Multi-agent development pipeline for Claude Code.** 10 steps from task to commit, with quality gates, isolated agent permissions, and persistent project vault.
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
PREFLIGHT → READ → PLAN → PLAN_REVIEW → CODER → REVIEW×3 → TEST → VERIFY → COMMIT
|
|
11
|
+
bash Explore Explore Explore Full Explore×3 bash Explore Full
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Why
|
|
15
|
+
|
|
16
|
+
Claude Code is powerful, but without structure it improvises. It skips reviews, forgets tests, loses context between sessions, and drifts from the original task.
|
|
17
|
+
|
|
18
|
+
dev-workflow gives it a **strict protocol**: every task goes through a 10-step pipeline with quality gates. Each agent is isolated by permissions. Context persists across sessions.
|
|
19
|
+
|
|
20
|
+
## Features
|
|
21
|
+
|
|
22
|
+
- **10-step quality pipeline** — preflight, plan with pseudo-code, plan review (9 criteria), test-first coding, 3 parallel reviewers, mandatory test gate, task verification, commit
|
|
23
|
+
- **Agent isolation** — reader can't write, coder can't commit, reviewer can't modify code
|
|
24
|
+
- **3 specialized reviewers** — security, quality, and coverage run in parallel on real `git diff`
|
|
25
|
+
- **Vault** — persistent project knowledge: stack, conventions, architecture, gameplan
|
|
26
|
+
- **Intelligence** — pattern graph with scoring (recency, frequency, context match)
|
|
27
|
+
- **Phase mode** — break large specs into phases, code each subtask separately
|
|
28
|
+
- **Interactive & autonomous** — ask before commit (default) or auto-commit for swarm use
|
|
29
|
+
- **13 MCP tools** — programmatic access to vault, tasks, intelligence
|
|
30
|
+
- **5 hooks** — session-start/end, post-edit, post-task, pre-compact
|
|
31
|
+
- **From spec to code** — `/vault:from-spec` fills vault from SPEC.md in 4 phased steps
|
|
32
|
+
|
|
33
|
+
## Quick Start
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
npm install -g @engramm/dev-workflow
|
|
37
|
+
cd your-project
|
|
38
|
+
dev-workflow init
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Then in Claude Code (VS Code or CLI):
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
/vault:analyze # fill vault from existing codebase
|
|
45
|
+
/workflow:dev "add email validation" # run the full pipeline
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### New project from specification
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
/vault:from-spec # fill vault from SPEC.md
|
|
52
|
+
/workflow:dev .dev-vault/phases/phase-1-foundation.md # implement phase 1
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Pipeline
|
|
56
|
+
|
|
57
|
+
| Step | Agent | What it does |
|
|
58
|
+
|------|-------|-------------|
|
|
59
|
+
| 0. PREFLIGHT | bash | Baseline: git status, build, tests |
|
|
60
|
+
| 1. READ | Explore | Gather context from codebase |
|
|
61
|
+
| 2. PLAN | Explore | Architecture analysis + pseudo-code |
|
|
62
|
+
| 3. PLAN_REVIEW | Explore | 9 criteria: completeness, architecture, production readiness |
|
|
63
|
+
| 4. CODER | Full | Test-first implementation |
|
|
64
|
+
| 5. REVIEW | Explore ×3 | Security + Quality + Coverage (parallel, real git diff) |
|
|
65
|
+
| 6. FIX LOOP | Full + Explore | Coder fixes, reviewer re-checks (max 3 iterations) |
|
|
66
|
+
| 7. TEST | bash | Build + lint + tests (compared against baseline) |
|
|
67
|
+
| 8. VERIFY | Explore | Does the code match the original task? |
|
|
68
|
+
| 9. COMMIT | Full | Stage + commit (interactive or autonomous) |
|
|
69
|
+
|
|
70
|
+
## Permission Matrix
|
|
71
|
+
|
|
72
|
+
```
|
|
73
|
+
Agent Read Write Bash Subagent
|
|
74
|
+
───────────── ───── ────── ───────────── ────────
|
|
75
|
+
READ yes no no Explore
|
|
76
|
+
PLAN yes no no Explore
|
|
77
|
+
PLAN_REVIEW yes no no Explore
|
|
78
|
+
CODER yes yes build/test Full
|
|
79
|
+
REVIEW ×3 yes no no Explore
|
|
80
|
+
TEST no no build/test bash
|
|
81
|
+
VERIFY yes no no Explore
|
|
82
|
+
COMMIT no no git only Full
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Violation = immediate pipeline abort.
|
|
86
|
+
|
|
87
|
+
## Slash Commands
|
|
88
|
+
|
|
89
|
+
### Vault
|
|
90
|
+
|
|
91
|
+
| Command | Description |
|
|
92
|
+
|---------|------------|
|
|
93
|
+
| `/vault:from-spec` | Fill vault from project specification (4 phases with approval gates) |
|
|
94
|
+
| `/vault:analyze` | Deep codebase analysis, fill conventions + knowledge |
|
|
95
|
+
| `/vault:bug` | Record a resolved bug |
|
|
96
|
+
| `/vault:adr` | Record an architecture decision |
|
|
97
|
+
| `/vault:debt` | Record tech debt |
|
|
98
|
+
| `/vault:deps` | Map module dependencies |
|
|
99
|
+
| `/vault:security-scan` | Security audit |
|
|
100
|
+
| `/vault:test-gaps` | Find untested code |
|
|
101
|
+
|
|
102
|
+
### Workflow
|
|
103
|
+
|
|
104
|
+
| Command | Description |
|
|
105
|
+
|---------|------------|
|
|
106
|
+
| `/workflow:dev "task"` | Full 10-step pipeline |
|
|
107
|
+
| `/workflow:dev path/phase.md` | Phase mode (subtask loop) |
|
|
108
|
+
| `/workflow:dev "task" --auto-commit` | Autonomous mode for swarm |
|
|
109
|
+
|
|
110
|
+
### Session
|
|
111
|
+
|
|
112
|
+
| Command | Description |
|
|
113
|
+
|---------|------------|
|
|
114
|
+
| `/session:resume` | Restore session context |
|
|
115
|
+
| `/session:handover` | Save detailed session notes |
|
|
116
|
+
| `/session:review` | Multi-perspective code review (5 perspectives) |
|
|
117
|
+
|
|
118
|
+
### Git
|
|
119
|
+
|
|
120
|
+
| Command | Description |
|
|
121
|
+
|---------|------------|
|
|
122
|
+
| `/git:new-branch` | Create branch context |
|
|
123
|
+
| `/git:pr-review` | PR review with vault context |
|
|
124
|
+
| `/git:changelog` | Generate changelog |
|
|
125
|
+
| `/git:merge` | Transfer knowledge after merge |
|
|
126
|
+
|
|
127
|
+
## CLI
|
|
128
|
+
|
|
129
|
+
```bash
|
|
130
|
+
dev-workflow init [--force] [--detect] # Initialize vault and hooks
|
|
131
|
+
dev-workflow status # Vault and workflow status
|
|
132
|
+
dev-workflow doctor [--fix] # Health check
|
|
133
|
+
dev-workflow task create|list|start|done # Task management
|
|
134
|
+
dev-workflow agent list|show|run # Agent management
|
|
135
|
+
dev-workflow run dev|hotfix|review|test # CLI workflows
|
|
136
|
+
dev-workflow search "query" # Search vault
|
|
137
|
+
dev-workflow config show|get|set # Configuration
|
|
138
|
+
dev-workflow export|import # Vault backup
|
|
139
|
+
dev-workflow serve # Start MCP server
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## MCP Tools
|
|
143
|
+
|
|
144
|
+
13 tools available via MCP server:
|
|
145
|
+
|
|
146
|
+
| Tool | Description |
|
|
147
|
+
|------|------------|
|
|
148
|
+
| `vault_status` | Full vault state in one call |
|
|
149
|
+
| `vault_read` | Read vault section |
|
|
150
|
+
| `vault_search` | Search vault files |
|
|
151
|
+
| `vault_record` | Create ADR/bug/debt record |
|
|
152
|
+
| `vault_knowledge` | Append to knowledge.md |
|
|
153
|
+
| `intelligence_query` | Query pattern graph with scoring |
|
|
154
|
+
| `task_create` | Create task |
|
|
155
|
+
| `task_list` | List tasks |
|
|
156
|
+
| `task_update` | Update task |
|
|
157
|
+
| `task_start` | Start task (link to branch) |
|
|
158
|
+
| `workflow_status` | Current workflow status |
|
|
159
|
+
| `agent_list` | List agents with permissions |
|
|
160
|
+
| `agent_run` | Generate agent prompt with vault context |
|
|
161
|
+
|
|
162
|
+
## Documentation
|
|
163
|
+
|
|
164
|
+
Full documentation: [supostat.github.io/dev-workflow](https://supostat.github.io/dev-workflow/)
|
|
165
|
+
|
|
166
|
+
## License
|
|
167
|
+
|
|
168
|
+
MIT
|
package/dist/cli/index.js
CHANGED
|
File without changes
|