Skip to content

Commit 3cb7692

Browse files
author
Test User
committed
docs: Update README.md for v0.0.19-beta release
- Updated version reference to v0.0.19-beta - Added all 5 new phases features: * Phase 1: Unified TUI & AI Commands (15 menu actions) * Phase 2: Design System (DPR) generation * Phase 3: Secrets & API Keys (RAKD/SOPS) management * Phase 4: AI Agents System (6 specialized agents) * Phase 5: Workflow Guidance Engine - Added TUI menu actions documentation - Updated project structure with new directories - Added new workflow steps (13-18) - Enhanced features section with all new capabilities
1 parent d140292 commit 3cb7692

File tree

1 file changed

+211
-10
lines changed

1 file changed

+211
-10
lines changed

README.md

Lines changed: 211 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,47 @@ Whether you're building a web application, API service, mobile app, or any softw
2222
- **Phase & Feature Management**: Organize your project into phases and features with automatic directory structure
2323
- **Progress Tracking**: Real-time progress monitoring with visual dashboards (markdown and HTML)
2424
- **Document Generation**: Auto-generate PRD, project structure, API contracts, and planning documents
25+
- **Workflow Guidance**: Intelligent recommendations for next steps based on your current progress
2526

26-
### 🎨 **Interactive Interface**
27-
- **Fullscreen TUI**: Beautiful terminal user interface with interactive dashboard
27+
### 🎨 **Interactive TUI Interface**
28+
- **Fullscreen TUI Menu**: Beautiful terminal user interface with 15 interactive actions
2829
- **Visual Progress Bars**: See project, phase, and feature progress at a glance
29-
- **Multi-view Dashboard**: Switch between project overview, phases, features, GitHub activity, and configuration
30+
- **Multi-view Dashboard**: Switch between project overview, phases, features, GitHub activity, configuration, and statistics
31+
- **Real-time Updates**: Live refresh of progress, GitHub data, and recommendations
32+
- **API Keys Widget**: Dashboard integration for API key status monitoring
33+
34+
### 🤖 **AI Agents System** *(NEW in v0.0.19-beta)*
35+
- **6 Specialized Agents**: Planner, Designer, Coder, Reviewer, Tester, DevOps
36+
- **Workflow Enforcement**: Agents follow strict workflow sequence (Plan → Design → Code → Test → Review → Deploy)
37+
- **Agent Definitions**: Comprehensive agent files with roles, responsibilities, and communication protocols
38+
- **Workflow Rules**: Automated rules for agent handoffs and task sequencing
39+
- **Communication Protocols**: Tag-based communication system for agent collaboration
40+
41+
### 🎨 **Design System (DPR)** *(NEW in v0.0.19-beta)*
42+
- **Interactive Questionnaire**: Guided questionnaire for design preferences and requirements
43+
- **DPR Document**: Complete Design Preferences & Requirements document generation
44+
- **Design Tokens**: Auto-generated `design-tokens.json` with colors, typography, spacing, and more
45+
- **AI Agent Rules**: `design_rules.mdc` for AI agents to follow design system guidelines
46+
- **Design System Maintenance**: Guidelines for keeping design system current
47+
48+
### 🔐 **Secrets & API Keys Management** *(NEW in v0.0.19-beta)*
49+
- **Service Detection**: Automatically detects required services from project files (package.json, go.mod, etc.)
50+
- **API Key Validation**: Validates API keys in `.env` files with format checking
51+
- **RAKD Document**: Required API Keys Document (RAKD.md) with status and validation results
52+
- **SOPS Guides**: Service Operating Procedures guides for each detected service
53+
- **TUI Management**: Interactive TUI for managing API keys and viewing status
54+
55+
### 🚀 **Deployment & Publishing** *(NEW in v0.0.19-beta)*
56+
- **Multi-Platform Deployment**: Deploy to Vercel, Netlify, Railway, Render, Coolify, Docker
57+
- **Package Publishing**: Publish to npm, Homebrew, Scoop, Winget
58+
- **Auto-Detection**: Automatically detects and recommends deployment platforms
59+
- **Interactive Wizards**: Beautiful TUI wizards for deployment and publishing configuration
60+
61+
### 🛡️ **Security & Auto-Fix** *(NEW in v0.0.19-beta)*
62+
- **Security Scanning**: Comprehensive security scans (npm audit, gosec, git-secrets, trufflehog)
63+
- **Auto-Fix**: Automated fixes for common issues (npm audit fix, go mod tidy, go fmt, ESLint)
64+
- **AI Suggestions**: Placeholder for AI-powered fix suggestions
65+
- **Severity Reporting**: Reports issues by severity level with actionable recommendations
3066

3167
### 🔧 **GitHub Integration**
3268
- **Automatic Branching**: Create feature branches automatically
@@ -47,9 +83,10 @@ Whether you're building a web application, API service, mobile app, or any softw
4783
- **Auto-Checkpointing**: Automatic checkpoints for features and phases
4884

4985
### 🔌 **IDE Integration**
50-
- **Multi-IDE Support**: Works with Cursor, Gemini CLI, Claude CLI, Codex CLI, OpenCode, and Qwen Code
86+
- **Multi-IDE Support**: Works with Cursor, VS Code, Gemini CLI, Claude CLI, Codex CLI, OpenCode, Qwen Code, and more
5187
- **Custom Commands**: IDE-specific commands for seamless workflow integration
5288
- **Workflow Rules**: Automated rules and conventions for your development process
89+
- **Setup Wizard**: Interactive TUI wizard for IDE integration setup
5390

5491
## Installation
5592

@@ -105,7 +142,7 @@ sudo mv doplan /usr/local/bin/
105142
# Extract and add to PATH
106143
```
107144

108-
**Latest Release:** [v0.0.17-beta](https://github.com/DoPlan-dev/CLI/releases/tag/v0.0.17-beta) | [View all releases](https://github.com/DoPlan-dev/CLI/releases)
145+
**Latest Release:** [v0.0.19-beta](https://github.com/DoPlan-dev/CLI/releases/tag/v0.0.19-beta) | [View all releases](https://github.com/DoPlan-dev/CLI/releases)
109146

110147
### From Source
111148

@@ -134,13 +171,36 @@ doplan --version
134171

135172
| Command | Description |
136173
|---------|-------------|
174+
| `doplan` | Launch interactive TUI menu (15 actions) |
137175
| `doplan install` | Install DoPlan in your project (interactive IDE selection) |
138176
| `doplan dashboard` | View project dashboard with progress and GitHub activity |
139177
| `doplan --tui` | Launch fullscreen interactive TUI dashboard |
140178
| `doplan github` | Sync GitHub data (branches, commits, PRs) and update dashboard |
141179
| `doplan progress` | Update all progress tracking files and regenerate dashboard |
142180
| `doplan validate` | Validate project structure, configuration, and state consistency |
143181

182+
### TUI Menu Actions *(NEW in v0.0.19-beta)*
183+
184+
When you run `doplan`, you get an interactive TUI menu with 15 actions:
185+
186+
| Action | Description |
187+
|--------|-------------|
188+
| 📊 View Dashboard | View project progress and statistics |
189+
| ▶️ Run Dev Server | Auto-detect and run development server (Node/Go/Docker) |
190+
| ↩️ Undo Last Action | Revert the last DoPlan action |
191+
| 🚀 Deploy Project | Deploy to Vercel, Netlify, Railway, etc. |
192+
| 📦 Publish Package | Publish to npm, Homebrew, Scoop, Winget |
193+
| ✨ Create New Project | Start a new DoPlan project |
194+
| 🛡️ Run Security Scan | Scan for vulnerabilities and security issues |
195+
| 🩹 Auto-fix Issues | AI-powered auto-fix for common issues |
196+
| 💬 Discuss Idea | Refine your project idea |
197+
| 📝 Generate Documents | Generate PRD, contracts, and documentation |
198+
| 🗺️ Create Plan | Create phase and feature structure |
199+
| 📈 Update Progress | Update progress tracking files |
200+
| 🔑 Manage API Keys | Detect, validate, and manage API keys |
201+
| 🎨 Apply Design / DPR | Generate design system and tokens |
202+
| ⚙️ Setup AI/IDE Integration | Configure IDE integration (Cursor, VS Code, etc.) |
203+
144204
### Configuration Commands
145205

146206
| Command | Description |
@@ -412,40 +472,181 @@ doplan config set checkpoint.autoFeature true
412472
doplan config validate
413473
```
414474

475+
### Step 13: Generate Design System (DPR) *(NEW in v0.0.19-beta)*
476+
477+
Create a comprehensive design system for your project:
478+
479+
**Via TUI:**
480+
```bash
481+
doplan
482+
# Select "🎨 Apply Design / DPR"
483+
```
484+
485+
This will:
486+
- Guide you through an interactive questionnaire
487+
- Generate `doplan/design/DPR.md` - Complete design specifications
488+
- Generate `doplan/design/design-tokens.json` - Design tokens (colors, typography, spacing)
489+
- Generate `.doplan/ai/rules/design_rules.mdc` - Rules for AI agents to follow design system
490+
491+
### Step 14: Manage API Keys *(NEW in v0.0.19-beta)*
492+
493+
Detect and manage API keys for your project services:
494+
495+
**Via TUI:**
496+
```bash
497+
doplan
498+
# Select "🔑 Manage API Keys"
499+
```
500+
501+
This will:
502+
- Detect required services from your project files (package.json, go.mod, etc.)
503+
- Validate API keys in `.env` files
504+
- Generate `doplan/RAKD.md` - Required API Keys Document
505+
- Generate `.doplan/SOPS/` - Service Operating Procedures guides for each service
506+
507+
### Step 15: Deploy Your Project *(NEW in v0.0.19-beta)*
508+
509+
Deploy to your preferred platform:
510+
511+
**Via TUI:**
512+
```bash
513+
doplan
514+
# Select "🚀 Deploy Project"
515+
```
516+
517+
Supported platforms:
518+
- Vercel
519+
- Netlify
520+
- Railway
521+
- Render
522+
- Coolify
523+
- Docker
524+
525+
### Step 16: Publish Your Package *(NEW in v0.0.19-beta)*
526+
527+
Publish to package registries:
528+
529+
**Via TUI:**
530+
```bash
531+
doplan
532+
# Select "📦 Publish Package"
533+
```
534+
535+
Supported registries:
536+
- npm
537+
- Homebrew
538+
- Scoop
539+
- Winget
540+
541+
### Step 17: Use AI Agents *(NEW in v0.0.19-beta)*
542+
543+
Work with specialized AI agents in your IDE:
544+
545+
**Available Agents:**
546+
- **@planner** - Project planning, PRD generation, idea refinement
547+
- **@designer** - Design specifications following DPR
548+
- **@coder** - Implementation based on plans and designs
549+
- **@tester** - Test creation and execution with screenshot capture
550+
- **@reviewer** - Code review and quality assurance
551+
- **@devops** - Deployment and infrastructure management
552+
553+
**Workflow Sequence:**
554+
```
555+
Plan → Design → Code → Test → Review → Deploy
556+
```
557+
558+
**In Cursor:**
559+
```
560+
@planner /Plan # Start planning
561+
@designer /Design # Create design specs
562+
@coder /Implement # Implement feature
563+
@tester /Test # Run tests
564+
@reviewer /Review # Review code
565+
@devops /Deploy # Deploy feature
566+
```
567+
568+
### Step 18: Get Workflow Guidance *(NEW in v0.0.19-beta)*
569+
570+
Receive intelligent recommendations after each action:
571+
572+
After completing any action, DoPlan will:
573+
- Display a "Recommended Next Step" box
574+
- Suggest the next action based on your current progress
575+
- Guide you through the optimal workflow sequence
576+
577+
**Example:**
578+
```
579+
✅ Plan created!
580+
581+
💡 Recommended Next Step: Create Design Specifications
582+
Use @designer /Design to create design specifications for your first feature,
583+
or use the TUI menu: [d]esign
584+
```
585+
415586
## Project Structure
416587

417588
After installation, your project will have this structure:
418589

419590
```
420591
project-root/
421592
├── .cursor/ # Cursor IDE integration (or .gemini/, .claude/, etc.)
422-
│ ├── commands/ # DoPlan command definitions
423-
│ ├── rules/ # Workflow rules and policies
593+
│ ├── agents/ # AI agent definitions (symlinked from .doplan/ai/agents/)
594+
│ ├── rules/ # Workflow rules (symlinked from .doplan/ai/rules/)
595+
│ ├── commands/ # DoPlan command definitions (symlinked from .doplan/ai/commands/)
424596
│ └── config/ # Configuration and state
425597
│ ├── doplan-config.json
426598
│ └── doplan-state.json
599+
├── .doplan/ # DoPlan configuration directory
600+
│ ├── ai/ # AI integration files
601+
│ │ ├── agents/ # AI agent definitions (6 agents)
602+
│ │ │ ├── README.md
603+
│ │ │ ├── planner.agent.md
604+
│ │ │ ├── designer.agent.md
605+
│ │ │ ├── coder.agent.md
606+
│ │ │ ├── reviewer.agent.md
607+
│ │ │ ├── tester.agent.md
608+
│ │ │ └── devops.agent.md
609+
│ │ ├── rules/ # Workflow and communication rules
610+
│ │ │ ├── workflow.mdc
611+
│ │ │ ├── communication.mdc
612+
│ │ │ └── design_rules.mdc (if DPR applied)
613+
│ │ └── commands/ # IDE command definitions
614+
│ │ ├── run.md
615+
│ │ ├── deploy.md
616+
│ │ ├── create.md
617+
│ │ └── ...
618+
│ ├── SOPS/ # Service Operating Procedures guides
619+
│ │ ├── stripe.md
620+
│ │ ├── sendgrid.md
621+
│ │ ├── aws-s3.md
622+
│ │ └── ...
623+
│ └── config.yaml # DoPlan configuration
427624
├── doplan/ # Planning directory
428625
│ ├── dashboard.md # Visual progress dashboard
429626
│ ├── dashboard.html # HTML version of dashboard
430627
│ ├── PRD.md # Product Requirements Document
431628
│ ├── structure.md # Project structure
432629
│ ├── CONTEXT.md # Tech stack and documentation
630+
│ ├── RAKD.md # Required API Keys Document (if services detected)
631+
│ ├── design/ # Design system files (if DPR applied)
632+
│ │ ├── DPR.md # Design Preferences & Requirements
633+
│ │ └── design-tokens.json
433634
│ ├── contracts/ # API contracts
434635
│ │ ├── api-spec.json
435636
│ │ └── data-model.md
436637
│ ├── templates/ # Reusable templates
437638
│ │ ├── plan-template.md
438639
│ │ ├── design-template.md
439640
│ │ └── tasks-template.md
440-
│ ├── 01-phase/ # Phase 1
641+
│ ├── 01-phase/ # Phase 1 (numbered format)
441642
│ │ ├── phase-plan.md
442643
│ │ ├── phase-progress.json
443-
│ │ ├── 01-Feature/
644+
│ │ ├── 01-feature/ # Feature 1 (numbered format)
444645
│ │ │ ├── plan.md
445646
│ │ │ ├── design.md
446647
│ │ │ ├── tasks.md
447648
│ │ │ └── progress.json
448-
│ │ └── 02-Feature/
649+
│ │ └── 02-feature/ # Feature 2
449650
│ │ └── ...
450651
│ └── 02-phase/ # Phase 2
451652
│ └── ...

0 commit comments

Comments
 (0)