CODE Framework

Clarify. Outline. Document. Evolve.

"All ideas deserve a story."

CODE is an AI-assisted development framework that helps anyone - coders and non-coders alike - ship their ideas. It takes you from a simple idea to a living, evolving product through structured workflows, quality gates, and personality-driven AI agents.

Quick Start

# Install CODE to your project
npx code-framework

# Follow the interactive prompts to:
# 1. Select your AI CLI tools (Claude Code, Cursor, Windsurf, etc.)
# 2. Install framework files
# 3. Configure your chosen tools

Supported AI CLI Tools

CODE Framework integrates with multiple AI coding assistants:

| Tool | Status | Config File | |------|--------|-------------| | Claude Code ⭐ | Recommended | .claude/commands.yaml, CLAUDE.md | | Cursor ⭐ | Recommended | .cursorrules | | Windsurf | Supported | .windsurfrules | | Antigravity | Supported | .antigravity/commands.yaml | | OpenCode | Supported | .opencode/commands.yaml | | Aider | Supported | CONVENTIONS.md | | Cline | Supported | .clinerules |

Two Starting Points

Greenfield (New Projects)

Starting from scratch? Follow the full CODE journey:

1. CLARIFY    /code-brief → Fill out your BRIEF (5 sections)
     ↓        └─ Quality Gate: /code-checklist-brief
2. OUTLINE    /code-outline → AI generates architecture + epics
     ↓        └─ Quality Gate: /code-checklist-architecture
3. DOCUMENT   /code-ux → Sitemap & wireframes
     ↓        /code-story → Create implementation-ready story from epic
     ↓        └─ Quality Gate: /code-checklist-story
4. EVOLVE     /code-dev → Implement story (write code, tests, validate)
     ↓        └─ Quality Gate: /code-checklist-code
             /code-evolve → Add features, repeat
             └─ Quality Gate: /code-checklist-release

Brownfield (Existing Projects)

Have existing code? Start here instead:

1. ANALYZE    /code-analyze → Document existing codebase
     ↓        Creates: architecture, components, APIs, data models
2. CONTEXT    /code-context → Extract patterns and rules
     ↓        Creates: project-context.md (the "brain" for AI)
3. BUILD      Choose your path:
              ├─ /code-story → /code-dev → Story-based development
              └─ /code-spec → /code-quick → Rapid feature development

Quick Flow (Rapid Development)

For experienced users who want speed over ceremony:

/code-spec   → Conversational spec engineering (AI asks questions, investigates code)
     ↓
/code-quick  → Rapid implementation from spec

Your Project Structure After Install

your-project/
├── _code/                      # Framework (read-only)
│   ├── agents/                 # AI agent personalities
│   ├── workflows/              # Guided processes
│   ├── templates/              # Output templates
│   └── checklists/             # Quality gates
│
├── 1-context/                  # YOUR CONTEXT (start here!)
│   ├── v1.0.0/                 # Version 1 of your idea
│   │   ├── 1-brainstorm/       # B - What's your idea?
│   │   ├── 2-requirements/     # R - What must it do?
│   │   ├── 3-inspiration/      # I - What inspires you?
│   │   ├── 4-entities/         # E - Who uses it? What data?
│   │   └── 5-framework/        # F - Technical preferences
│   └── _active.yaml            # Points to current version
│
├── 2-outline/                  # Technical architecture
│   └── v1.0.0/
│       ├── technical-outline.md
│       ├── data-schema.md
│       └── api-outline.md
│
├── 3-ux/                       # UX Design & Wireframes
│   └── v1.0.0/
│       ├── sitemap.md          # Complete page inventory
│       └── wireframes/         # AI prompts for each page
│
├── 4-documentation/            # Living Plan
│   ├── epics/                  # Epic files (growing list)
│   └── stories/                # Story files by epic
│
├── 5-evolution/                # Change tracking
│   └── changelog.md            # What changed and when
│
└── research/                   # Optional deep research

Meet Your Team

| Agent | Role | When to Call | |-------|------|--------------| | SAGE 🧙 | Guide & Orchestrator | Start here, coordinates everything | | Ramon 🎯 | Context Architect | Helps fill out BRIEF | | Lorenzo 🏗️ | Technical Architect | Generates Outline | | Audrey 🎨 | Experience Designer | Creates UX & Wireframes | | Chris 📋 | Product Manager | Writes Epics & Stories, prioritizes | | Emil 🚀 | Evolution Strategist + Business Analyst | Manages features, analyzes requirements | | Mark 🎨 | UI Designer | Visual design, UI components, design systems | | Jude 💻 | Developer + Tech Writer | Implements stories, writes docs | | Rovic 🧪 | Quality Guide + Scrum Master | Reviews, tests, facilitates |

Commands

All commands use the /code- prefix to avoid conflicts with other tools.

Core Workflow Commands

| Command | Phase | Description | |---------|-------|-------------| | /code-brief | Clarify | Fill out your BRIEF (5 sections) | | /code-outline | Outline | Generate technical architecture + epics | | /code-ux | Document | Generate sitemap and wireframe prompts | | /code-story | Document | Create implementation-ready story from epic | | /code-dev | Evolve | Implement story (write code, tests, validate) | | /code-evolve | Evolve | Add a new feature (creates new version) |

Brownfield Commands (Existing Projects)

| Command | Description | |---------|-------------| | /code-analyze | Document existing codebase (architecture, APIs, data) | | /code-context | Extract patterns and rules into project-context.md |

Quick Flow Commands

| Command | Description | |---------|-------------| | /code-spec | Conversational spec engineering (AI investigates + asks questions) | | /code-quick | Rapid implementation from spec |

Utility Commands

| Command | Description | |---------|-------------| | /code-help | Show help and available commands | | /code-status | Check project status and next steps | | /code-sage | Start here - SAGE guides you through everything | | /code-review | Review and QA any work | | /code-research | Research a topic and save findings |

Quality Gate Commands

| Command | Description | |---------|-------------| | /code-checklist-brief | Validate BRIEF completeness | | /code-checklist-architecture | Review technical architecture | | /code-checklist-story | Validate story before implementation | | /code-checklist-code | Code review checklist | | /code-checklist-release | Pre-release verification |

Quality Gates

Each workflow has a corresponding quality checklist:

| Checklist | When to Use | Location | |-----------|-------------|----------| | Brief Checklist | After BRIEF, before Outline | _code/checklists/brief-checklist.md | | Architecture Checklist | After Outline, before Docs | _code/checklists/architecture-checklist.md | | Story Checklist | Before implementing a story | _code/checklists/story-checklist.md | | Code Review Checklist | Before merging code | _code/checklists/code-review-checklist.md | | Pre-Release Checklist | Before production deployment | _code/checklists/pre-release-checklist.md |

Philosophy

1. All ideas deserve a story - Every feature, every thought gets documented
2. AI-assisted, human-controlled - AI suggests, you decide
3. Quality gates matter - Checklists prevent disasters before they happen
4. Living documentation - Your plan grows with your project
5. Context isolation - New features don't pollute old context
6. Ship, don't dream - Everything exists to help you launch

Comparison with BMAD

CODE Framework is a streamlined alternative to the BMAD Method:

| Aspect | BMAD | CODE | |--------|------|------| | Setup | CLI wizard with many options | Simple npx with tool selection | | Structure | Role-based (personas, agents, tasks) | Version-based (v1.0.0 folders) | | Commands | /bmad-* prefix | /code-* prefix | | Quality Gates | Comprehensive checklists | 5 essential checklists | | Best For | Enterprises, large teams | Solo devs, small teams, MVPs |

License

MIT - Use it, modify it, make it yours.