farmwork
v1.5.1
Published
Farmwork - A workflow framework for Claude Code by Wynter Jones
Maintainers
Readme
A workflow framework for Claude Code by Wynter Jones
Quick Start
npm install -g farmworkcd your-project
farmwork init
farmwork doctor
farmwork statusOr run directly with npx:
npx farmwork initThe Farmwork Method
Core Concepts
- Skills - Auto-activating workflows that respond to natural phrases
- Slash Commands - Explicit triggers for actions like
/push - Agents - 15 specialized AI subagents for specific tasks
- Supplies - Built-in tools and MCP integrations to extend your farm
- Issue Tracking - Using beads (
bd) for full visibility - Living Audits - Documents that track ongoing concerns
- Plan & Implement - You describe the outcome, the rest is handled
- Idea Garden - Pre-plan creative stage with natural aging
Skills (Auto-Activating Workflows)
Skills auto-activate when you use these natural phrases:
| Phrase | Skill | What Happens |
|--------|-------|--------------|
| open the farm | farm-audit | Audit systems, update FARMHOUSE.md |
| count the herd | farm-inspect | Full code inspection (no push) |
| go to market | market | i18n + WCAG accessibility audit |
| go to production | production | Update BROWNFIELD, strategy check |
| I have an idea for... | garden | Plant idea in GARDEN.md |
| water the garden | garden | Generate 10 new ideas |
| compost this... | garden | Move idea to COMPOST.md |
| let's research... | research | Create/update _RESEARCH/ doc |
Slash Commands (Explicit Actions)
| Command | Description |
|---------|-------------|
| /push | Lint, test, build, commit, push (11 steps) |
| /office | Interactive strategy setup |
Skill Activation Hook
Farmwork adds a UserPromptSubmit hook that reminds Claude to check for applicable skills. This improves activation reliability over phrase commands in CLAUDE.md.
Agents
15 specialized agents included:
| Agent | Purpose |
|-------|---------|
| the-farmer | Audit and update FARMHOUSE.md metrics |
| code-reviewer | Quality & security code review |
| security-auditor | OWASP vulnerability scanning |
| performance-auditor | Memory leaks, re-renders, anti-patterns |
| code-smell-auditor | DRY violations, complexity, naming |
| accessibility-auditor | WCAG 2.1 compliance, alt text, contrast |
| unused-code-cleaner | Detect and remove dead code |
| code-cleaner | Remove comments and console.logs |
| i18n-locale-translator | Translate UI text to locales |
| storybook-maintainer | Create/update Storybook stories |
| idea-gardener | Manage Idea Garden and Compost |
| researcher | Systematic research before planning |
| strategy-agent | Core loop strategy (what/stopping/why) |
| onboarding-agent | Tours, tooltips, modals, empty states |
| user-guide-agent | Feature documentation for help docs |
Supplies
Supplies are optional tools and MCP integrations that extend your farm's capabilities. Add them during farmwork init or anytime with farmwork supply.
Built-in Supplies
| Supply | Purpose |
|--------|---------|
| just | Command runner for project tasks |
| beads | Local, markdown-based issue tracking |
| knip | Dead code detection (unused files, deps, exports) |
MCP Supplies
| Supply | Purpose | Requires |
|--------|---------|----------|
| storybook | Connect Claude to your component library | Storybook installed |
| context7 | Up-to-date library documentation | None |
| sentry | Error tracking and monitoring | SENTRY_AUTH_TOKEN |
| images | AI image generation (Gemini/OpenAI) | API keys |
Recommended Workflow
- Start Session: Run
open the farmto audit current state - Capture Ideas: Use
I have an idea for...to plant ideas in GARDEN - Research: Use
let's research...to gather information before planning - Plan Work: Use
make a plan for...for new features - Implement: Use
let's implement...to execute with tracking - Quality Check: Run
count the herdfor full audit + dry run - Ship: Run
close the farmor/pushto push changes
You can go to market when you have a production-ready app with international users.
Directory Structure
your-project/
├── CLAUDE.md # Lean instructions (references skills)
├── .claude/ # Claude Code configuration
│ ├── skills/ # Auto-activating workflows (NEW!)
│ │ ├── farm-audit/ # "open the farm"
│ │ ├── farm-inspect/ # "count the herd"
│ │ ├── garden/ # idea management
│ │ ├── research/ # "let's research..."
│ │ ├── production/ # "go to production"
│ │ └── market/ # "go to market"
│ ├── agents/ # 15 specialized subagents
│ │ ├── the-farmer.md
│ │ ├── code-reviewer.md
│ │ ├── security-auditor.md
│ │ └── ... (12 more)
│ └── commands/ # Explicit slash commands
│ ├── push.md
│ └── office.md
├── _AUDIT/ # Living audit documents
│ ├── FARMHOUSE.md # Framework command center
│ ├── GARDEN.md # Idea nursery
│ ├── COMPOST.md # Rejected ideas
│ ├── KNIP.md # Dead code report (if enabled)
│ └── ... (security, performance, etc.)
├── _OFFICE/ # Product strategy
│ ├── GREENFIELD.md # Vision
│ ├── BROWNFIELD.md # Reality
│ └── ... (onboarding, user guide)
├── _PLANS/ # Implementation plans
├── _RESEARCH/ # Research documents
├── .beads/ # Issue tracking
└── justfile # Navigation commandsCommands
farmwork init
Start setting up the new digital farm:
farmwork init # Interactive setup wizardOptions:
-f, --force- Overwrite existing files
Optional Features: During init, you'll be asked about optional features:
- i18n - Internationalization support
- Storybook - Component documentation (React/Vue projects)
- Knip - Dead code detection (runs during farm-inspect)
- Supplies - MCP integrations (Storybook, Context7, Sentry, Images)
Creates:
CLAUDE.md- Lean instructions (references skills).claude/- Claude Code configuration directoryskills/- 6 auto-activating workflows (farm-audit, farm-inspect, garden, research, production, market)agents/- 15 specialized subagentscommands/- 2 slash commands (/push, /office)settings.local.json- Skill activation hook
_AUDIT/- Living audit documentsFARMHOUSE.md,GARDEN.md,COMPOST.md, and more
_OFFICE/- Product strategy documentsGREENFIELD.md,BROWNFIELD.md,ONBOARDING.md,USER_GUIDE.md
_PLANS/- Implementation plans directory_RESEARCH/- Research documents directoryjustfile- Navigation and task commands
farmwork status
Display Farmwork status and metrics.
farmwork statusShows:
- Component counts (agents, commands, audits, plans)
- Office documents status
- Issue tracking status (if beads is configured)
- FARMHOUSE score and open items
- Configuration file status
- Project metrics (tests, stories)
farmwork doctor
Check your Farmwork setup and diagnose issues.
farmwork doctorChecks:
- Core files (CLAUDE.md, .claude/, settings)
- Agents and commands configuration
- Audit system (_AUDIT/, FARMHOUSE.md, _PLANS/)
- Research system (_RESEARCH/)
- Office system (_OFFICE/, CORE_LOOP.md, ONBOARDING.md, USER_GUIDE.md)
- Navigation (justfile, just command)
- Issue tracking (beads)
- Security (.gitignore settings)
farmwork supply
Add supplies to your farm - tools and MCP integrations.
farmwork supply # Interactive supply selection
farmwork supply images # Install specific supplyAvailable Supplies:
storybook- Storybook MCP server + skillcontext7- Context7 MCP for library documentationsentry- Sentry error tracking MCPimages- AI image generation (Gemini/OpenAI)
What It Does:
- Installs the MCP server via
claude mcp add - Creates a corresponding skill in
.claude/skills/ - Configures any required API keys
Requirements
- Node.js 18+
- just (recommended for navigation)
- beads (for issue tracking)
- knip (optional, for dead code detection)
License
MIT
