11# CodeFRAME
22
3- ![ Status] ( https://img.shields.io/badge/status-v2%20Phase%201%20In%20Progress-blue )
3+ ![ Status] ( https://img.shields.io/badge/status-v2%20Phase%201%20Complete-brightgreen )
44![ License] ( https://img.shields.io/badge/license-AGPL--3.0-blue )
55![ Python] ( https://img.shields.io/badge/python-3.11%2B-blue )
6- ![ Tests] ( https://img.shields.io/badge/tests-3043 %20passing-brightgreen )
6+ ![ Tests] ( https://img.shields.io/badge/tests-4122 %20passing-brightgreen )
77![ Coverage] ( https://img.shields.io/badge/coverage-88%25-brightgreen )
88[ ![ Follow on X] ( https://img.shields.io/twitter/follow/FrankBria18044?style=social )] ( https://x.com/FrankBria18044 )
99
@@ -23,21 +23,83 @@ Unlike traditional AI coding assistants that wait for your prompts, CodeFRAME ag
2323
2424---
2525
26- ## What's New (Updated: 2026-01-29 )
26+ ## What's New (Updated: 2026-02-01 )
2727
28- ### V2 Strategic Roadmap Published
28+ ### V2 Phase 1 Complete 🎉
2929
30- We've completed the v2 strategic planning and published a comprehensive 5-phase roadmap :
30+ We've completed Phase 1 of the v2 strategic roadmap! The CLI foundation is now production-ready :
3131
32- - ** Phase 1** (Current): CLI Foundation - ` cf prd generate ` , live streaming, integration tests
33- - ** Phase 2** : Server Layer as thin adapter over core
34- - ** Phase 3** : Web UI rebuild on v2 foundation
35- - ** Phase 4** : Multi-Agent Coordination (the "FRAME" vision)
36- - ** Phase 5** : Advanced Features (TUI, metrics, replay)
32+ | Feature | Status | Issue |
33+ | ---------| --------| -------|
34+ | ` cf prd generate ` - Interactive AI PRD creation | ✅ Complete | #307 |
35+ | ` cf work follow ` - Live execution streaming | ✅ Complete | #308 |
36+ | PRD template system for customizable output | ✅ Complete | #316 |
37+ | Integration tests for credentials/environment | ✅ Complete | #309 |
38+ | Bug fixes (#265 , #253 ) | ✅ Complete | - |
39+
40+ ** Next up** : Phase 2 (Server Layer) - See [ docs/V2_STRATEGIC_ROADMAP.md] ( docs/V2_STRATEGIC_ROADMAP.md )
41+
42+ ### Interactive PRD Generation
43+
44+ ** ` cf prd generate ` ** — AI-guided requirements discovery using Socratic questioning.
45+
46+ ``` bash
47+ # Start interactive PRD creation
48+ cf prd generate
49+
50+ # Non-interactive with initial description
51+ cf prd generate --description " User authentication system with OAuth"
52+
53+ # Use specific template
54+ cf prd generate --template lean
55+ cf prd generate --template enterprise
56+ ```
57+
58+ The AI conducts 5+ turn discovery sessions, progressively refining from broad vision → specific requirements → acceptance criteria.
59+
60+ ### PRD Template System
61+
62+ ** Customizable PRD output formats** for different team needs:
63+
64+ ``` bash
65+ # List available templates
66+ cf prd templates list
67+
68+ # Show template structure
69+ cf prd templates show standard
70+
71+ # Export template for customization
72+ cf prd templates export enterprise ./my-template.yaml
73+
74+ # Import custom template
75+ cf prd templates import ./my-template.yaml
76+ ```
77+
78+ ** Built-in templates:**
79+ - ` standard ` - Balanced PRD with all essential sections
80+ - ` lean ` - Minimal viable PRD for rapid iteration
81+ - ` enterprise ` - Comprehensive PRD with compliance sections
82+ - ` technical ` - Developer-focused with architecture details
83+ - ` user-story ` - Agile/Scrum format with user stories
84+
85+ ### Live Execution Streaming
86+
87+ ** ` cf work follow ` ** — Watch agent execution in real-time.
3788
38- See [ docs/V2_STRATEGIC_ROADMAP.md] ( docs/V2_STRATEGIC_ROADMAP.md ) for full details.
89+ ``` bash
90+ # Stream live output from a running task
91+ cf work follow < task-id>
92+
93+ # Show last 50 lines then continue streaming
94+ cf work follow < task-id> --tail 50
95+ ```
3996
40- ### Environment Validation & Tool Detection
97+ ---
98+
99+ ### Previous Updates
100+
101+ <details >
102+ <summary >Environment Validation & Tool Detection (2026-01-29)</summary >
41103
42104** New ` cf env ` commands** — Validate your development environment and auto-install missing tools.
43105
@@ -61,7 +123,10 @@ cf env auto-install --yes
61123- Rust: clippy, rustfmt, rust-analyzer, cargo-edit
62124- System: git, docker, make, curl, gh
63125
64- ### GitHub PR Workflow Commands
126+ </details >
127+
128+ <details >
129+ <summary >GitHub PR Workflow Commands (2026-01-29)</summary >
65130
66131** New ` cf pr ` commands** — Manage pull requests directly from the CLI.
67132
@@ -82,7 +147,10 @@ cf pr merge 123 --method squash
82147cf pr close 123
83148```
84149
85- ### Task Self-Diagnosis
150+ </details >
151+
152+ <details >
153+ <summary >Task Self-Diagnosis (2026-01-29)</summary >
86154
87155** New ` cf work diagnose ` command** — Automatically analyze failed tasks and get actionable recommendations.
88156
@@ -96,17 +164,10 @@ cf work diagnose <task-id> --verbose
96164
97165The diagnostic agent analyzes run logs, identifies root causes, and provides specific fix recommendations.
98166
99- ### Bug Fixes
100-
101- - ** Fixed #265 ** : NoneType error when ` codebase_index ` is None during task execution
102- - ** Fixed #253 ** : Checkpoint diff API now returns 404 instead of 500 when workspace directory is missing
103-
104- ---
105-
106- ### Previous: Enhanced Task Generation (2026-01-25)
167+ </details >
107168
108169<details >
109- <summary >Task Scheduling & Templates</summary >
170+ <summary >Task Scheduling & Templates (2026-01-25) </summary >
110171
111172** Task Scheduling with Critical Path Analysis:**
112173
@@ -229,11 +290,13 @@ cf work batch run --all-ready --retry 3
229290- ** Autonomous Execution** — ` cf work start --execute ` runs the full agent loop
230291- ** Self-Correction Loop** — Agent automatically fixes failing verification gates (up to 3 attempts)
231292- ** Human-in-the-Loop Blockers** — Agents pause and ask questions when they need decisions
232- - ** Verification Gates** — Automatic ruff/pytest checks after changes
293+ - ** Verification Gates** — Automatic ruff/pytest/BUILD checks after changes
294+ - ** Live Streaming** — ` cf work follow ` for real-time execution output
233295- ** Verbose Mode** — ` --verbose ` flag shows detailed progress and self-correction activity
234296- ** Dry Run Mode** — Preview changes without applying them
235297- ** State Persistence** — Resume work across sessions
236298- ** Task Diagnosis** — Automatic root cause analysis for failed tasks
299+ - ** PRD Generation** — AI-guided requirements discovery with templates
237300
238301### Multi-Agent Orchestration
239302- ** Multi-Agent Orchestra** — Lead agent coordinates backend, frontend, test, and review specialists
@@ -261,6 +324,7 @@ cf work batch run --all-ready --retry 3
261324- ** PR Workflow** — ` cf pr create/list/merge ` for GitHub integration
262325- ** Task Scheduling** — CPM-based critical path analysis
263326- ** Task Templates** — 7 built-in templates for common development patterns
327+ - ** PRD Templates** — 5 built-in PRD formats for different team needs
264328- ** Cost Tracking** — Real-time token usage and cost analytics per agent/task
265329
266330---
@@ -335,7 +399,9 @@ cd /path/to/your/project
335399cf init . --detect
336400# Or explicit: cf init . --tech-stack "Python with FastAPI, uv, pytest"
337401
338- # 2. Add a PRD (Product Requirements Document)
402+ # 2. Generate PRD interactively (NEW!)
403+ cf prd generate
404+ # Or add existing PRD file
339405cf prd add requirements.md
340406
341407# 3. Generate tasks from PRD
@@ -347,17 +413,20 @@ cf tasks list
347413# 5. Start work on a task (with AI agent)
348414cf work start < task-id> --execute
349415
350- # 6. Check for blockers (questions the agent needs answered)
416+ # 6. Follow execution in real-time (NEW!)
417+ cf work follow < task-id>
418+
419+ # 7. Check for blockers (questions the agent needs answered)
351420cf blocker list
352421cf blocker answer < blocker-id> " Your answer here"
353422
354- # 7 . Resume work after answering blockers
423+ # 8 . Resume work after answering blockers
355424cf work resume < task-id>
356425
357- # 8 . If a task fails, diagnose the issue
426+ # 9 . If a task fails, diagnose the issue
358427cf work diagnose < task-id>
359428
360- # 9 . Review changes and create checkpoint
429+ # 10 . Review changes and create checkpoint
361430cf review
362431cf checkpoint create " Feature complete"
363432```
@@ -401,11 +470,21 @@ cf env auto-install --yes # Install all missing tools
401470
402471### PRD (Product Requirements)
403472``` bash
404- cf prd add < file.md> # Add/update PRD
405- cf prd show # Display current PRD
406- cf prd list # List all PRDs
407- cf prd versions < id> # Show version history
408- cf prd diff < id> < v1> < v2> # Compare versions
473+ cf prd generate # Interactive AI-guided PRD creation (NEW!)
474+ cf prd generate --template lean # Use specific template
475+ cf prd add < file.md> # Add/update PRD from file
476+ cf prd show # Display current PRD
477+ cf prd list # List all PRDs
478+ cf prd versions < id> # Show version history
479+ cf prd diff < id> < v1> < v2> # Compare versions
480+ ```
481+
482+ ### PRD Templates
483+ ``` bash
484+ cf prd templates list # List available templates
485+ cf prd templates show < id> # Show template structure
486+ cf prd templates export < id> < path> # Export template to file
487+ cf prd templates import < path> # Import custom template
409488```
410489
411490### Task Management
@@ -438,6 +517,8 @@ cf work start <id> --execute --verbose # Execute with detailed output
438517cf work start < id> --execute --dry-run # Preview changes only
439518cf work stop < id> # Stop current run
440519cf work resume < id> # Resume blocked work
520+ cf work follow < id> # Stream real-time output (NEW!)
521+ cf work follow < id> --tail 50 # Show last N lines then stream
441522cf work diagnose < id> # Diagnose failed task
442523```
443524
@@ -580,11 +661,11 @@ uv run pytest -m v2
580661
581662### Test Statistics
582663
583- - ** Total Tests** : 3000 +
584- - Core module tests: ~ 815
585- - Unit tests: ~ 900 (Python + TypeScript)
586- - Integration tests: ~ 500
587- - E2E tests: 85 + (Backend + Playwright)
664+ - ** Total Tests** : 4100 +
665+ - Core module tests: ~ 1200
666+ - Unit tests: ~ 1500 (Python + TypeScript)
667+ - Integration tests: ~ 800
668+ - E2E tests: 100 + (Backend + Playwright)
588669- ** Coverage** : 88%+
589670- ** Pass Rate** : 100%
590671
@@ -640,30 +721,32 @@ We welcome contributions! To get started:
640721## Roadmap
641722
642723### Completed
643- - Phase 0: CLI-first Golden Path workflow
644- - Phase 1 (Batch): Batch execution (serial), status monitoring, cancellation
645- - Phase 2 (Batch): Parallel execution, dependency graphs, LLM inference, auto-retry
646- - Autonomous agent execution with blocker detection
647- - Verification gates integration
648- - Task-based model selection
649- - Self-correction loop for verification failures
650- - Verbose mode for observability
651- - Task scheduling with CPM analysis
652- - Task templates (7 built-in)
653- - Environment validation and tool detection
654- - GitHub PR workflow commands
655- - Task self-diagnosis system
656-
657- ### In Progress (Phase 1: CLI Foundation)
658- - ** ` cf prd generate ` ** : Interactive AI-driven PRD creation (Socratic discovery)
659- - ** ` cf work follow ` ** : Live streaming of task execution
660- - ** Integration tests** : Credential and environment module coverage
661-
662- ### Planned (Phases 2-5)
663- - ** Phase 2** : Server layer as thin adapter, OpenAPI docs, rate limiting
724+ - ** Phase 0** : CLI-first Golden Path workflow
725+ - ** Phase 1** : CLI Foundation ✅
726+ - Interactive PRD generation with Socratic discovery
727+ - Live execution streaming (` cf work follow ` )
728+ - PRD template system
729+ - Integration tests for credentials/environment
730+ - Batch execution (serial, parallel, auto strategies)
731+ - Self-correction loop for verification failures
732+ - Task scheduling with CPM analysis
733+ - Task templates (7 built-in)
734+ - Environment validation and tool detection
735+ - GitHub PR workflow commands
736+ - Task self-diagnosis system
737+
738+ ### In Progress (Phase 2: Server Layer)
739+ - ** Server audit and refactor** (#322 ) — Routes delegating to core modules
740+ - ** Real-time events** (#323 ) — SSE/WebSocket for execution streaming
741+ - ** API key authentication** (#324 ) — Programmatic API access
742+ - ** OpenAPI documentation** (#119 ) — Auto-generated API docs
743+ - ** Rate limiting** (#167 ) — Security and abuse prevention
744+ - ** API pagination** (#118 ) — Large dataset support
745+
746+ ### Planned (Phases 3-5)
664747- ** Phase 3** : Web UI rebuild on v2 foundation
665- - ** Phase 4** : Multi-agent coordination, agent roles, conflict resolution
666- - ** Phase 5** : TUI dashboard, token/cost tracking, debug/replay mode
748+ - ** Phase 4** : Multi-agent coordination ( agent roles, conflict resolution, handoffs)
749+ - ** Phase 5** : Advanced features ( TUI dashboard, token/cost tracking, debug/replay mode)
667750
668751See [ docs/V2_STRATEGIC_ROADMAP.md] ( docs/V2_STRATEGIC_ROADMAP.md ) for the complete roadmap.
669752
0 commit comments