farmwork 1.0.0 → 1.0.1

package/README.md

@@ -1,44 +1,132 @@
-# Farmwork
+<img src="/init.png" alt="Farmwork - Developer Methodology" width="500" />
 
-> Agentic development harness for AI-assisted projects
+# FARMWORK
 
-Farmwork is a framework that transforms AI coding assistants from reactive tools into proactive development partners. The name is a play on "framework" - because building software should feel like tending a well-organized farm.
+> A workflow framework for Claude Code by Wynter Jones
 
-## Installation
+...because building software should feel like tending a well-organized farm.
+
+## Quick Start
 
 ```bash
 npm install -g farmwork
 ```
 
+```bash
+cd your-project
+farmwork init
+farmwork doctor
+farmwork status
+```
+
 Or run directly with npx:
 
 ```bash
 npx farmwork init
 ```
 
-## Quick Start
+----
 
-```bash
-# Initialize in your project
-cd your-project
-farmwork init
+## The Farmwork Method
 
-# Check your setup
-farmwork doctor
+### Core Concepts
 
-# View framework status
-farmwork status
+1. **FARMHOUSE.md** - Central command for tracking framework metrics
+2. **Phrase Commands** - Natural language triggers for workflows
+3. **Agents** - Specialized AI subagents for specific tasks
+4. **Commands** - User-invocable skills (triggered with `/command`)
+5. **Issue Tracking** - Using beads (`bd`) for full visibility
+6. **Living Audits** - Documents that track ongoing concerns
+
+### Phrase Commands
+
+**Farmwork Phrases** (Development Workflow):
+| Phrase | Action |
+|--------|--------|
+| `till the land` | Audit systems, update FARMHOUSE.md metrics |
+| `inspect the farm` | Full inspection (code review, performance, security, quality) |
+| `go to market` | i18n translation check |
+| `harvest crops` | Full push workflow (lint, test, build, commit, push) |
+| `open the farm` | Full audit cycle, then ask to proceed |
+
+**Plan Phrases**:
+| Phrase | Action |
+|--------|--------|
+| `make a plan for...` | Create implementation plan in `_PLANS/` |
+| `let's implement...` | Execute plan with issue tracking |
+
+### Slash Commands
+
+| Command | Description |
+|---------|-------------|
+| `/push` | Stage, lint, test, build, commit, push |
+| `/open-the-farm` | Full audit cycle with summary report |
+
+### Agents
+
+9 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 |
+| `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 |
+
+### Recommended Workflow
+
+1. **Start Session**: Run `till the land` to audit current state
+2. **Plan Work**: Use `make a plan for...` for new features
+3. **Implement**: Use `let's implement...` to execute with tracking
+4. **Quality Check**: Run `inspect the farm` or `/open-the-farm`
+5. **Ship**: Run `harvest crops` or `/push` to push changes
+
+## Directory Structure
+
+```
+your-project/
+├── CLAUDE.md           # Main instructions & phrase commands
+├── .claude/            # Claude Code configuration
+│   ├── agents/         # 9 specialized subagents
+│   │   ├── the-farmer.md
+│   │   ├── code-reviewer.md
+│   │   ├── security-auditor.md
+│   │   ├── performance-auditor.md
+│   │   ├── code-smell-auditor.md
+│   │   ├── unused-code-cleaner.md
+│   │   ├── code-cleaner.md
+│   │   ├── i18n-locale-translator.md
+│   │   └── storybook-maintainer.md
+│   └── commands/       # User-invocable skills
+│       ├── push.md
+│       └── open-the-farm.md
+├── _AUDIT/             # Living audit documents
+│   ├── FARMHOUSE.md    # Framework command center
+│   ├── SECURITY.md     # Security posture
+│   ├── PERFORMANCE.md  # Performance metrics
+│   ├── CODE_QUALITY.md # Code quality tracking
+│   └── TESTS.md        # Test coverage
+├── _PLANS/             # Implementation plans
+│   └── FEATURE_NAME.md
+├── .beads/             # Issue tracking
+└── justfile            # Navigation commands
 ```
 
+<img src="/logo.png" alt="Farmwork - Developer Methodology" width="300" />
+
 ## Commands
 
 ### `farmwork init`
 
-Initialize the Farmwork framework in your current directory. Runs an interactive setup wizard to configure your project for any tech stack.
+Start setting up the new digital farm:
 
 ```bash
 farmwork init                    # Interactive setup wizard
-farmwork init -f                 # Force overwrite existing files
 ```
 
 **Options:**
@@ -55,30 +143,21 @@ If you enable Storybook (for React/Vue projects), the wizard will also ask for:
 - `CLAUDE.md` - Main instructions and phrase commands
 - `.claude/` - Claude Code configuration directory
   - `settings.json` - Project settings
-  - `agents/` - Specialized subagents
-  - `commands/` - User-invocable skills
+  - `agents/` - 9 specialized subagents
+  - `commands/` - 2 user-invocable skills
 - `_AUDIT/` - Living audit documents
   - `FARMHOUSE.md` - Framework command center
+  - `SECURITY.md` - Security posture tracking
+  - `PERFORMANCE.md` - Performance metrics
+  - `CODE_QUALITY.md` - Code quality tracking
+  - `TESTS.md` - Test coverage tracking
 - `_PLANS/` - Implementation plans directory
 - `justfile` - Navigation and task commands
 
-### `farmwork add <type> <name>`
-
-Add a new component to your Farmwork setup.
-
-```bash
-farmwork add agent code-reviewer     # Add a new agent
-farmwork add command deploy          # Add a new command
-farmwork add audit performance       # Add a new audit document
-```
-
-**Types:**
-- `agent` - Creates `.claude/agents/<name>.md`
-- `command` - Creates `.claude/commands/<name>.md`
-- `audit` - Creates `_AUDIT/<NAME>.md`
-
 ### `farmwork status`
 
+<img src="/status.png" alt="Farmwork Status" width="500" />
+
 Display Farmwork status and metrics.
 
 ```bash
@@ -92,8 +171,12 @@ farmwork status
 - Configuration file status
 - Project metrics (tests, stories)
 
+<img src="/status2.png" alt="Farmwork Status Details" width="500" />
+
 ### `farmwork doctor`
 
+<img src="/doctor.png" alt="Farmwork Doctor" width="500" />
+
 Check your Farmwork setup and diagnose issues.
 
 ```bash
@@ -108,67 +191,12 @@ farmwork doctor
 - Issue tracking (beads)
 - Security (.gitignore settings)
 
-## The Farmwork Method
-
-### Core Concepts
-
-1. **FARMHOUSE.md** - Central command for tracking framework metrics
-2. **Phrase Commands** - Natural language triggers for workflows
-3. **Agents** - Specialized AI subagents for specific tasks
-4. **Commands** - User-invocable skills (triggered with `/command`)
-5. **Issue Tracking** - Using beads (`bd`) for full visibility
-6. **Living Audits** - Documents that track ongoing concerns
-
-### Phrase Commands
-
-**Farmwork Phrases** (Development Workflow):
-- `till the land` - Audit systems, update metrics
-- `inspect the farm` - Full inspection (code review, performance, security, quality)
-- `go to market` - i18n translation check
-- `harvest crops` - Full push workflow
-
-**Plan Phrases**:
-- `make a plan for...` - Create implementation plan
-- `let's implement...` - Execute plan with issue tracking
-
-### Recommended Workflow
-
-1. **Start Session**: Run `till the land` to audit current state
-2. **Plan Work**: Use `make a plan for...` for new features
-3. **Implement**: Use `let's implement...` to execute with tracking
-4. **Quality Check**: Run `inspect the farm`
-5. **Ship**: Run `harvest crops` to push changes
-
-## Directory Structure
-
-```
-your-project/
-├── CLAUDE.md           # Main instructions & phrase commands
-├── .claude/            # Claude Code configuration
-│   ├── settings.json   # Project settings
-│   ├── agents/         # Specialized subagents
-│   │   ├── code-reviewer.md
-│   │   ├── security-auditor.md
-│   │   └── ...
-│   └── commands/       # User-invocable skills
-│       ├── push.md
-│       └── ...
-├── _AUDIT/             # Living audit documents
-│   ├── FARMHOUSE.md    # Framework command center
-│   ├── SECURITY.md
-│   ├── PERFORMANCE.md
-│   └── ...
-├── _PLANS/             # Implementation plans
-│   └── FEATURE_NAME.md
-├── .beads/             # Issue tracking (optional)
-└── justfile            # Navigation commands
-```
 
 ## Requirements
 
 - Node.js 18+
 - [just](https://github.com/casey/just) (recommended for navigation)
-- [beads](https://github.com/steveyegge/beads) (optional, for issue tracking)
+- [beads](https://github.com/steveyegge/beads) (for issue tracking)
 
 ## License
 

package/bin/farmwork.js

@@ -2,7 +2,6 @@
 
 import { program } from 'commander';
 import { init } from '../src/init.js';
-import { add } from '../src/add.js';
 import { status } from '../src/status.js';
 import { doctor } from '../src/doctor.js';
 import chalk from 'chalk';
@@ -26,11 +25,6 @@ program
   .option('-f, --force', 'Overwrite existing files')
   .action(init);
 
-program
-  .command('add <type> <name>')
-  .description('Add a component (agent, command, audit)')
-  .action(add);
-
 program
   .command('status')
   .description('Show Farmwork status and metrics')

package/package.json

@@ -1,12 +1,17 @@
 {
   "name": "farmwork",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "description": "Farmwork - Agentic development harness for AI-assisted projects",
   "main": "src/index.js",
   "bin": {
     "farmwork": "./bin/farmwork.js"
   },
+  "files": [
+    "src",
+    "bin",
+    "templates"
+  ],
   "scripts": {
     "test": "node --test",
     "lint": "eslint src/"
@@ -25,9 +30,10 @@
   "dependencies": {
     "chalk": "^5.3.0",
     "commander": "^12.1.0",
+    "fs-extra": "^11.2.0",
     "inquirer": "^9.2.12",
     "ora": "^8.0.1",
-    "fs-extra": "^11.2.0"
+    "terminal-kit": "^3.1.1"
   },
   "engines": {
     "node": ">=18.0.0"

package/src/doctor.js

@@ -1,7 +1,7 @@
 import fs from "fs-extra";
 import path from "path";
-import chalk from "chalk";
 import { execSync } from "child_process";
+import { farmTerm, emojis } from "./terminal.js";
 
 function checkExists(filePath, description) {
   const exists = fs.existsSync(filePath);
@@ -54,8 +54,7 @@ function checkClaudeMdSections(claudeMdPath) {
   const content = fs.readFileSync(claudeMdPath, "utf8");
   const requiredSections = [
     "Phrase Commands",
-    "Issue Tracking",
-    "Claude Code Commands",
+    "Issue-First Workflow",
   ];
 
   const missing = requiredSections.filter(
@@ -115,27 +114,24 @@ function checkGitignore(cwd) {
 export async function doctor() {
   const cwd = process.cwd();
 
-  console.log(chalk.cyan("\n🩺 Farmwork Doctor\n"));
-  console.log(chalk.gray("Checking your Farmwork setup...\n"));
+  farmTerm.logo();
+  farmTerm.header("FARMWORK DOCTOR", "accent");
+  await farmTerm.analyzing("Diagnosing project health", 1200);
 
   const checks = [];
 
-  checks.push({ category: "Core Files", items: [] });
+  // Core Files
+  checks.push({ category: "Core Files", emoji: "🌾", items: [] });
   checks[0].items.push(
     checkExists(path.join(cwd, "CLAUDE.md"), "CLAUDE.md exists"),
   );
   checks[0].items.push(
     checkExists(path.join(cwd, ".claude"), ".claude/ directory exists"),
   );
-  checks[0].items.push(
-    checkExists(
-      path.join(cwd, ".claude", "settings.json"),
-      "settings.json exists",
-    ),
-  );
   checks[0].items.push(checkClaudeMdSections(path.join(cwd, "CLAUDE.md")));
 
-  checks.push({ category: "Agents & Commands", items: [] });
+  // Agents & Commands
+  checks.push({ category: "Agents & Commands", emoji: "🐴", items: [] });
   checks[1].items.push(
     checkDirectoryNotEmpty(
       path.join(cwd, ".claude", "agents"),
@@ -149,7 +145,8 @@ export async function doctor() {
     ),
   );
 
-  checks.push({ category: "Audit System", items: [] });
+  // Audit System
+  checks.push({ category: "Audit System", emoji: "🦉", items: [] });
   checks[2].items.push(
     checkExists(path.join(cwd, "_AUDIT"), "_AUDIT/ directory exists"),
   );
@@ -166,56 +163,67 @@ export async function doctor() {
     checkExists(path.join(cwd, "_PLANS"), "_PLANS/ directory exists"),
   );
 
-  checks.push({ category: "Navigation", items: [] });
+  // Navigation
+  checks.push({ category: "Navigation", emoji: "🐓", items: [] });
   checks[3].items.push(
     checkExists(path.join(cwd, "justfile"), "justfile exists"),
   );
   checks[3].items.push(checkCommand("just", "just command available"));
 
-  checks.push({ category: "Issue Tracking", items: [] });
+  // Issue Tracking
+  checks.push({ category: "Issue Tracking", emoji: "🐷", items: [] });
   checks[4].items.push(
     checkExists(path.join(cwd, ".beads"), ".beads/ directory exists"),
   );
   checks[4].items.push(checkCommand("bd", "bd (beads) command available"));
 
-  checks.push({ category: "Security", items: [] });
+  // Security
+  checks.push({ category: "Security", emoji: "🐕", items: [] });
   checks[5].items.push(checkGitignore(cwd));
 
   let totalPassed = 0;
   let totalFailed = 0;
   let totalWarnings = 0;
 
+  // Run checks with animation
   for (const category of checks) {
-    console.log(chalk.bold(`${category.category}`));
+    farmTerm.section(category.category, category.emoji);
 
     for (const check of category.items) {
+      // Small delay for visual effect
+      await new Promise(r => setTimeout(r, 80));
+
       if (check.passed) {
-        console.log(chalk.green(`  🌱 ${check.message}`));
+        farmTerm.status(check.message, "pass");
         totalPassed++;
       } else {
-        if (check.message.includes("beads") || check.message.includes("bd ")) {
-          console.log(chalk.yellow(`  🍋 ${check.message}`));
-          if (check.details) console.log(chalk.gray(`    ${check.details}`));
+        // Beads-related items are optional (warnings)
+        const isOptional = check.message.includes("beads") || check.message.includes("bd ");
+        if (isOptional) {
+          farmTerm.status(check.message, "warn", check.details || "(optional)");
           totalWarnings++;
         } else {
-          console.log(chalk.red(`  🍂 ${check.message}`));
-          if (check.details) console.log(chalk.gray(`    ${check.details}`));
+          farmTerm.status(check.message, "fail", check.details || "");
           totalFailed++;
         }
       }
     }
-    console.log();
   }
 
-  console.log(chalk.bold("Summary"));
-  console.log(chalk.green(`  🌱 ${totalPassed} passed`));
+  // Summary
+  farmTerm.nl();
+  farmTerm.divider("═", 50);
+  farmTerm.section("Diagnosis Summary", "🐮");
+
+  farmTerm.metric("Passed", totalPassed, emojis.seedling);
   if (totalWarnings > 0) {
-    console.log(chalk.yellow(`  🍋 ${totalWarnings} warnings (optional)`));
+    farmTerm.metric("Warnings", totalWarnings, emojis.leaf);
   }
   if (totalFailed > 0) {
-    console.log(chalk.red(`  🍂 ${totalFailed} failed`));
+    farmTerm.metric("Failed", totalFailed, "🍂");
   }
 
+  // Health Assessment
   const health =
     totalFailed === 0
       ? totalWarnings === 0
@@ -225,20 +233,28 @@ export async function doctor() {
         ? "Needs Attention"
         : "Critical";
 
-  const healthColor =
-    health === "Excellent"
-      ? chalk.green
-      : health === "Good"
-        ? chalk.cyan
-        : health === "Needs Attention"
-          ? chalk.yellow
-          : chalk.red;
-
-  console.log(`\n${chalk.bold("Health:")} ${healthColor(health)}`);
+  farmTerm.nl();
+  farmTerm.divider();
+
+  if (health === "Excellent") {
+    farmTerm.success(`Health: ${health} - Your farm is thriving! 🌳`);
+  } else if (health === "Good") {
+    farmTerm.info(`Health: ${health} - Growing nicely! 🌿`);
+  } else if (health === "Needs Attention") {
+    farmTerm.warn(`Health: ${health} - Some areas need work 🌱`);
+  } else {
+    farmTerm.error(`Health: ${health} - Urgent care needed! 🥀`);
+  }
 
   if (totalFailed > 0) {
-    console.log(chalk.gray("\nRun `farmwork init` to fix missing components."));
+    farmTerm.nl();
+    farmTerm.info("Run `farmwork init` to fix missing components.");
   }
 
-  console.log();
+  // Health bar visualization
+  const healthPercent = Math.round((totalPassed / (totalPassed + totalFailed + totalWarnings)) * 100);
+  farmTerm.nl();
+  farmTerm.score("Overall Health", healthPercent, 100);
+
+  farmTerm.nl();
 }

package/src/index.js

@@ -1,4 +1,3 @@
 export { init } from './init.js';
-export { add } from './add.js';
 export { status } from './status.js';
 export { doctor } from './doctor.js';