autoworkflow 2.0.0 → 2.0.1

package/README.md

@@ -1,8 +1,45 @@
 # AutoWorkflow - System Prompt Layer for Claude Code
 
-> **Claude is the enforcement engine.** No scripts, no git hooks - just instructions that Claude follows.
+> **Claude is the enforcement engine.** System prompts control the workflow. Scripts and hooks provide backup enforcement.
 
-A system prompt architecture that controls Claude Code's behavior through triggers, loops, gates, and routing. When you use Claude Code in VS Code with this project, Claude will automatically follow a structured workflow for all coding tasks.
+A system prompt architecture that controls Claude Code's behavior through triggers, loops, gates, and routing. When you use Claude Code in VS Code with this project, Claude automatically follows a structured 9-phase workflow for all coding tasks.
+
+---
+
+## Installation
+
+### Via npm (Recommended)
+
+```bash
+npm install autoworkflow
+```
+
+Then copy files to your project:
+
+```bash
+# Copy all workflow files
+cp -r node_modules/autoworkflow/CLAUDE.md .
+cp -r node_modules/autoworkflow/system ./system
+cp -r node_modules/autoworkflow/instructions ./instructions
+cp -r node_modules/autoworkflow/.claude ./.claude
+cp -r node_modules/autoworkflow/scripts ./scripts
+cp -r node_modules/autoworkflow/hooks ./hooks
+
+# Optional: Copy VS Code settings
+cp -r node_modules/autoworkflow/.vscode ./.vscode
+
+# Optional: Copy config examples
+cp node_modules/autoworkflow/.prettierrc .
+cp node_modules/autoworkflow/eslint.config.example.js ./eslint.config.js
+cp node_modules/autoworkflow/tsconfig.example.json ./tsconfig.json
+
+# Setup git hooks
+npm run setup:hooks
+```
+
+### Manual Installation
+
+Clone or download this repository and copy the files to your project.
 
 ---
 
@@ -29,60 +66,45 @@ A system prompt architecture that controls Claude Code's behavior through trigge
 │                                                              │
 │  CLAUDE.md    │  AI_RULES.md  │  BLUEPRINT.md               │
 │  Workflow     │  Standards     │  Project spec               │
+└───────────────────────────┬─────────────────────────────────┘
+                            │
+                            ▼
+┌─────────────────────────────────────────────────────────────┐
+│              Backup Enforcement (Runtime Layer)              │
+│                                                              │
+│  scripts/     │  hooks/        │  npm scripts               │
+│  Automation   │  Git hooks     │  Verification              │
 └─────────────────────────────────────────────────────────────┘
 ```
 
 ---
 
-## Quick Start
-
-1. **Copy this structure** into your project:
-   ```
-   your-project/
-   ├── CLAUDE.md                 # Entry point
-   ├── system/                   # Control layer
-   │   ├── triggers.md
-   │   ├── loops.md
-   │   ├── gates.md
-   │   └── router.md
-   ├── instructions/             # Content layer
-   │   ├── CLAUDE.md
-   │   ├── AI_RULES.md
-   │   └── BLUEPRINT.md
-   ├── .claude/                  # Claude Code integration
-   │   ├── settings.json
-   │   └── commands/
-   └── .vscode/                  # VS Code integration
-       ├── settings.json
-       ├── tasks.json
-       └── extensions.json
-   ```
-
-2. **Customize the instructions**:
-   - Edit `instructions/AI_RULES.md` with your coding standards
-   - Edit `instructions/BLUEPRINT.md` with your project spec
-
-3. **Use Claude Code** - Claude will automatically follow the workflow!
-
----
-
 ## The Workflow
 
-When you ask Claude to do something, it follows this workflow:
+When you ask Claude to do something, it follows this 9-phase workflow:
 
 ```
-ANALYZE → PLAN → CONFIRM → IMPLEMENT → VERIFY → AUDIT → COMMIT
+ANALYZE → PLAN → CONFIRM → IMPLEMENT → VERIFY → FIX → AUDIT → COMMIT → UPDATE
 ```
 
 | Phase | What Claude Does |
 |-------|------------------|
-| **ANALYZE** | Reads relevant files, understands context |
-| **PLAN** | Designs approach, shows suggestions |
+| **ANALYZE** | Reads relevant files, checks BLUEPRINT.md |
+| **PLAN** | Designs approach, shows categorized suggestions |
 | **CONFIRM** | Waits for your approval |
 | **IMPLEMENT** | Makes changes (only after approval) |
 | **VERIFY** | Runs `npm run verify` (typecheck + lint) |
+| **FIX** | Fixes errors, loops back to VERIFY |
 | **AUDIT** | Checks for orphan features, circular deps |
 | **COMMIT** | Creates conventional commit (after approval) |
+| **UPDATE** | Updates BLUEPRINT.md if new feature/route/API added |
+
+### Session Start
+
+At the start of every session, Claude:
+1. Checks if `instructions/BLUEPRINT.md` exists
+2. If missing → Runs `/audit project` to generate it
+3. If exists → Reads AI_RULES.md + BLUEPRINT.md and proceeds
 
 ---
 
@@ -109,6 +131,7 @@ Claude will STOP and cannot proceed if:
 | `/verify` | Run TypeScript + ESLint |
 | `/fix` | Fix verification errors |
 | `/audit` | Run UI + cycle audits |
+| `/audit project` | Full project scan → generates BLUEPRINT.md |
 | `/suggest [task]` | Generate suggestions |
 | `/commit [msg]` | Pre-commit check + commit |
 
@@ -126,10 +149,42 @@ Claude enforces these automatically:
 
 ---
 
+## npm Scripts
+
+### Verification
+```bash
+npm run verify           # TypeScript + ESLint
+npm run typecheck        # TypeScript only
+npm run lint             # ESLint only
+npm run format           # Prettier format
+```
+
+### Audits
+```bash
+npm run audit:ui         # Check orphan features (BLOCKING)
+npm run audit:cycles     # Check circular deps (BLOCKING)
+npm run audit:all        # Run all audits
+```
+
+### Workflow Automation
+```bash
+npm run dyad:status      # Show workflow status
+npm run dyad:verify      # Run verification
+npm run dyad:commit      # Commit with checks
+npm run dyad:full        # Full workflow
+```
+
+### Setup
+```bash
+npm run setup:hooks      # Install git hooks
+```
+
+---
+
 ## File Structure
 
 ```
-@autoworkflow/
+autoworkflow/
 ├── CLAUDE.md                 # Entry point (Claude reads this first)
 │
 ├── system/                   # Control Layer
@@ -139,7 +194,7 @@ Claude enforces these automatically:
 │   └── router.md             # Task type routing
 │
 ├── instructions/             # Content Layer
-│   ├── CLAUDE.md             # Workflow steps
+│   ├── CLAUDE.md             # Workflow steps (9 phases)
 │   ├── AI_RULES.md           # Coding standards
 │   └── BLUEPRINT.md          # Project specification
 │
@@ -155,32 +210,55 @@ Claude enforces these automatically:
 │       ├── suggest.md
 │       └── commit.md
 │
-└── .vscode/                  # VS Code Integration
-    ├── settings.json         # Editor settings
-    ├── tasks.json            # Runnable tasks
-    └── extensions.json       # Recommended extensions
+├── scripts/                  # Automation Scripts
+│   ├── setup.sh              # Initial setup
+│   ├── autoworkflow.sh       # Workflow automation
+│   ├── check-ui-enforcement.sh
+│   ├── run-verification.sh
+│   └── ensure-no-errors.sh
+│
+├── hooks/                    # Git Hooks (backup enforcement)
+│   ├── pre-commit            # Blocks bad commits
+│   └── commit-msg            # Validates commit messages
+│
+├── .vscode/                  # VS Code Integration (optional)
+│   ├── settings.json         # Editor settings
+│   ├── tasks.json            # Runnable tasks
+│   └── extensions.json       # Recommended extensions
+│
+├── .prettierrc               # Prettier config
+├── eslint.config.example.js  # ESLint config template
+└── tsconfig.example.json     # TypeScript config template
 ```
 
 ---
 
 ## Why This Approach?
 
-### Traditional Enforcement
-- Git hooks run scripts
-- Scripts check code
-- Blocks commit on failure
-
-### AutoWorkflow (This Approach)
-- Claude reads instructions
-- Claude follows the workflow
-- Claude enforces rules as it works
+### Dual Enforcement Strategy
 
-**Benefits:**
-- No runtime code to maintain
-- Works in any project (just copy files)
+**Primary: Claude as Enforcement Engine**
+- Claude reads instructions from system prompts
+- Claude follows the 9-phase workflow
+- Claude enforces rules proactively as it works
 - Claude explains what's happening
-- Flexible - Claude can adapt to context
-- Suggestions improve code quality proactively
+
+**Backup: Scripts & Git Hooks**
+- Git hooks catch anything Claude misses
+- Scripts automate verification
+- Pre-commit blocks bad code from reaching the repo
+
+### Benefits
+
+| Feature | Benefit |
+|---------|---------|
+| System prompts | No runtime code to maintain |
+| Portable | Just copy files to any project |
+| Transparent | Claude explains the workflow |
+| Flexible | Claude adapts to context |
+| Suggestions | Proactively improves code quality |
+| Git hooks | Backup enforcement layer |
+| npm scripts | Easy automation |
 
 ---
 
@@ -223,11 +301,25 @@ Edit `system/loops.md` to change retry behavior.
 ## Requirements
 
 - VS Code with Claude Code extension
-- That's it! No npm install needed for the workflow itself.
+- Node.js 18+ (for npm scripts)
+- TypeScript, ESLint, Prettier (for verification)
+
+---
+
+## What Gets Copied
+
+When you install via npm, these files are available to copy:
 
-If you want the verification commands (`npm run verify`, etc.) to work, you'll need:
-- Node.js 18+
-- TypeScript, ESLint, etc. in your project
+| Category | Files | Required? |
+|----------|-------|-----------|
+| Entry point | `CLAUDE.md` | ✅ Yes |
+| Control layer | `system/` | ✅ Yes |
+| Content layer | `instructions/` | ✅ Yes |
+| Claude integration | `.claude/` | ✅ Yes |
+| Automation | `scripts/` | Recommended |
+| Git hooks | `hooks/` | Recommended |
+| VS Code | `.vscode/` | Optional |
+| Configs | `.prettierrc`, `*.example.*` | Optional |
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autoworkflow",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "System prompt layer that controls Claude Code's workflow with triggers, loops, and gates",
   "type": "module",
   "keywords": [