farmwork 1.4.5 → 1.4.6

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 (3) hide show
  1. package/README.md +56 -108
  2. package/package.json +1 -1
  3. package/src/init.js +1476 -1031
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- <img src="/images/init.png" alt="Farmwork - Developer Methodology" width="500" />
1
+ <img src="logo.png" alt="Farmwork - Developer Methodology" width="300" />
2
2
 
3
3
  > A workflow framework for Claude Code by Wynter Jones
4
4
 
@@ -27,66 +27,39 @@ npx farmwork init
27
27
 
28
28
  ### Core Concepts
29
29
 
30
- 1. **FARMHOUSE.md** - Central command for tracking framework metrics
31
- 2. **Phrase Commands** - Natural language triggers for workflows
32
- 3. **Agents** - Specialized AI subagents for specific tasks
33
- 4. **Autonomously Issue Tracking** - Using beads (`bd`) for full visibility
30
+ 1. **Skills** - Auto-activating workflows that respond to natural phrases
31
+ 2. **Slash Commands** - Explicit triggers for actions like `/push`
32
+ 3. **Agents** - 15 specialized AI subagents for specific tasks
33
+ 4. **Issue Tracking** - Using beads (`bd`) for full visibility
34
34
  5. **Living Audits** - Documents that track ongoing concerns
35
- 6. **Plan & Implement** - You describe the outcome, the rest is handled, tracked and audited
36
- 7. **Idea Garden & Compost** - Pre-plan creative stage with natural aging (ideas older than 60 days auto-compost)
37
-
38
- ### Phrase Commands
39
-
40
- **Farmwork Phrases** (Development Workflow):
41
- | Phrase | Action |
42
- |--------|--------|
43
- | `open the farm` | Audit systems, update FARMHOUSE.md metrics |
44
- | `count the herd` | Full inspection and audit |
45
- | `go to market` | i18n translation check + accessibility audit |
46
- | `close the farm` | Full push workflow (lint, test, build, commit, push) |
47
-
48
- **Plan Phrases**:
49
- | Phrase | Action |
50
- |--------|--------|
51
- | `make a plan for...` | Create implementation plan in `_PLANS/` |
52
- | `let's implement...` | Execute plan with issue tracking |
53
-
54
- **Idea Phrases** (Pre-Plan Stage):
55
- | Phrase | Action |
56
- |--------|--------|
57
- | `I have an idea for...` | Add new idea to `_AUDIT/GARDEN.md` with planted date |
58
- | `let's plan this idea...` | Graduate idea from GARDEN → create plan |
59
- | `compost this...` | Move rejected idea to `_AUDIT/COMPOST.md` |
60
- | `water the garden` | Generate 10 new ideas based on GARDEN and COMPOST |
61
-
62
- **Idea Lifecycle:**
63
- - **Fresh** (0-44 days) - New ideas ready to develop
64
- - **Wilting** (45-60 days) - Ideas aging, marked ⚠️ during audits
65
- - **Composted** (60+ days) - Auto-moved to COMPOST during "open the farm"
66
-
67
- **Research Phrases** (Pre-Plan Stage):
68
- | Phrase | Action |
69
- |--------|--------|
70
- | `let's research...` | Create or update research document in `_RESEARCH/` |
71
- | `update research on...` | Refresh existing research with new findings |
72
- | `show research on...` | Display research summary and staleness status |
73
-
74
- **Research Lifecycle:**
75
- - **Fresh** (0-14 days) - Research is current and reliable
76
- - **Aging** (15-30 days) - Consider refreshing for major decisions
77
- - **Stale** (30+ days) - Recommend updating before using for plans
78
-
79
- **Office Phrases** (Product Strategy & UX):
80
- | Phrase | Action |
81
- |--------|--------|
82
- | `go to production` | UX production check: update `_OFFICE/` docs with audit trail |
83
-
84
- ### Slash Commands
35
+ 6. **Plan & Implement** - You describe the outcome, the rest is handled
36
+ 7. **Idea Garden** - Pre-plan creative stage with natural aging
37
+
38
+ ### Skills (Auto-Activating Workflows)
39
+
40
+ Skills auto-activate when you use these natural phrases:
41
+
42
+ | Phrase | Skill | What Happens |
43
+ |--------|-------|--------------|
44
+ | `open the farm` | farm-audit | Audit systems, update FARMHOUSE.md |
45
+ | `count the herd` | farm-inspect | Full code inspection (no push) |
46
+ | `go to market` | market | i18n + WCAG accessibility audit |
47
+ | `go to production` | production | Update BROWNFIELD, strategy check |
48
+ | `I have an idea for...` | garden | Plant idea in GARDEN.md |
49
+ | `water the garden` | garden | Generate 10 new ideas |
50
+ | `compost this...` | garden | Move idea to COMPOST.md |
51
+ | `let's research...` | research | Create/update _RESEARCH/ doc |
52
+
53
+ ### Slash Commands (Explicit Actions)
85
54
 
86
55
  | Command | Description |
87
56
  |---------|-------------|
88
- | `/push` | Clean, stage, lint, test, build, commit, push, update metrics (11 steps) |
89
- | `/office` | Interactive strategy and UX command - updates CORE_LOOP, ONBOARDING, USER_GUIDE |
57
+ | `/push` | Lint, test, build, commit, push (11 steps) |
58
+ | `/office` | Interactive strategy setup |
59
+
60
+ ### Skill Activation Hook
61
+
62
+ Farmwork adds a `UserPromptSubmit` hook that reminds Claude to check for applicable skills. This improves activation reliability over phrase commands in CLAUDE.md.
90
63
 
91
64
  ### Agents
92
65
 
@@ -126,50 +99,38 @@ You can `go to market` when you have a production-ready app with international u
126
99
 
127
100
  ```
128
101
  your-project/
129
- ├── CLAUDE.md # Main instructions & phrase commands
102
+ ├── CLAUDE.md # Lean instructions (references skills)
130
103
  ├── .claude/ # Claude Code configuration
104
+ │ ├── skills/ # Auto-activating workflows (NEW!)
105
+ │ │ ├── farm-audit/ # "open the farm"
106
+ │ │ ├── farm-inspect/ # "count the herd"
107
+ │ │ ├── garden/ # idea management
108
+ │ │ ├── research/ # "let's research..."
109
+ │ │ ├── production/ # "go to production"
110
+ │ │ └── market/ # "go to market"
131
111
  │ ├── agents/ # 15 specialized subagents
132
112
  │ │ ├── the-farmer.md
133
113
  │ │ ├── code-reviewer.md
134
114
  │ │ ├── security-auditor.md
135
- │ │ ├── performance-auditor.md
136
- │ │ ├── code-smell-auditor.md
137
- │ │ ├── accessibility-auditor.md
138
- │ │ ├── unused-code-cleaner.md
139
- │ │ ├── code-cleaner.md
140
- │ │ ├── i18n-locale-translator.md
141
- │ │ ├── storybook-maintainer.md
142
- │ │ ├── idea-gardener.md
143
- │ │ ├── researcher.md
144
- │ │ ├── strategy-agent.md # Core loop strategy
145
- │ │ ├── onboarding-agent.md # UX onboarding
146
- │ │ └── user-guide-agent.md # Feature documentation
147
- │ └── commands/ # User-invocable skills
115
+ │ │ └── ... (12 more)
116
+ │ └── commands/ # Explicit slash commands
148
117
  │ ├── push.md
149
- │ └── office.md # Interactive strategy command
118
+ │ └── office.md
150
119
  ├── _AUDIT/ # Living audit documents
151
120
  │ ├── FARMHOUSE.md # Framework command center
152
- │ ├── SECURITY.md # Security posture
153
- │ ├── PERFORMANCE.md # Performance metrics
154
- │ ├── ACCESSIBILITY.md # WCAG 2.1 compliance
155
- │ ├── CODE_QUALITY.md # Code quality tracking
156
- │ ├── TESTS.md # Test coverage
157
- │ ├── GARDEN.md # Idea nursery (pre-plan stage)
158
- │ └── COMPOST.md # Rejected ideas archive
159
- ├── _OFFICE/ # Product strategy & UX docs
160
- │ ├── CORE_LOOP.md # What/Stopping/Why strategy
161
- │ ├── ONBOARDING.md # Tours, tooltips, modals
162
- │ └── USER_GUIDE.md # Feature documentation
121
+ │ ├── GARDEN.md # Idea nursery
122
+ │ ├── COMPOST.md # Rejected ideas
123
+ │ └── ... (security, performance, etc.)
124
+ ├── _OFFICE/ # Product strategy
125
+ │ ├── GREENFIELD.md # Vision
126
+ │ ├── BROWNFIELD.md # Reality
127
+ │ └── ... (onboarding, user guide)
163
128
  ├── _PLANS/ # Implementation plans
164
- │ └── FEATURE_NAME.md
165
- ├── _RESEARCH/ # Research documents (living docs)
166
- │ └── TOPIC_NAME.md
129
+ ├── _RESEARCH/ # Research documents
167
130
  ├── .beads/ # Issue tracking
168
131
  └── justfile # Navigation commands
169
132
  ```
170
133
 
171
- <img src="/images/logo.png" alt="Farmwork - Developer Methodology" width="300" />
172
-
173
134
  ## Commands
174
135
 
175
136
  ### `farmwork init`
@@ -191,31 +152,22 @@ If you enable Storybook (for React/Vue projects), the wizard will also ask for:
191
152
  - Password protection preference (recommended)
192
153
 
193
154
  **Creates:**
194
- - `CLAUDE.md` - Main instructions and phrase commands
155
+ - `CLAUDE.md` - Lean instructions (references skills)
195
156
  - `.claude/` - Claude Code configuration directory
157
+ - `skills/` - 6 auto-activating workflows (farm-audit, farm-inspect, garden, research, production, market)
196
158
  - `agents/` - 15 specialized subagents
197
- - `commands/` - 2 user-invocable skills (/push, /office)
159
+ - `commands/` - 2 slash commands (/push, /office)
160
+ - `settings.local.json` - Skill activation hook
198
161
  - `_AUDIT/` - Living audit documents
199
- - `FARMHOUSE.md` - Framework command center
200
- - `SECURITY.md` - Security posture tracking
201
- - `PERFORMANCE.md` - Performance metrics
202
- - `ACCESSIBILITY.md` - WCAG 2.1 compliance
203
- - `CODE_QUALITY.md` - Code quality tracking
204
- - `TESTS.md` - Test coverage tracking
205
- - `GARDEN.md` - Idea nursery (pre-plan stage)
206
- - `COMPOST.md` - Rejected ideas archive
207
- - `_OFFICE/` - Product strategy & UX documents
208
- - `CORE_LOOP.md` - What/Stopping/Why strategy
209
- - `ONBOARDING.md` - Tours, tooltips, modals
210
- - `USER_GUIDE.md` - Feature documentation
162
+ - `FARMHOUSE.md`, `GARDEN.md`, `COMPOST.md`, and more
163
+ - `_OFFICE/` - Product strategy documents
164
+ - `GREENFIELD.md`, `BROWNFIELD.md`, `ONBOARDING.md`, `USER_GUIDE.md`
211
165
  - `_PLANS/` - Implementation plans directory
212
166
  - `_RESEARCH/` - Research documents directory
213
167
  - `justfile` - Navigation and task commands
214
168
 
215
169
  ### `farmwork status`
216
170
 
217
- <img src="/images/status.png" alt="Farmwork Status" width="500" />
218
-
219
171
  Display Farmwork status and metrics.
220
172
 
221
173
  ```bash
@@ -230,12 +182,8 @@ farmwork status
230
182
  - Configuration file status
231
183
  - Project metrics (tests, stories)
232
184
 
233
- <img src="/images/status2.png" alt="Farmwork Status Details" width="500" />
234
-
235
185
  ### `farmwork doctor`
236
186
 
237
- <img src="/images/doctor.png" alt="Farmwork Doctor" width="500" />
238
-
239
187
  Check your Farmwork setup and diagnose issues.
240
188
 
241
189
  ```bash
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "farmwork",
3
- "version": "1.4.5",
3
+ "version": "1.4.6",
4
4
  "type": "module",
5
5
  "description": "Farmwork - A workflow framework for Claude Code by Wynter Jones",
6
6
  "main": "src/index.js",