-
Notifications
You must be signed in to change notification settings - Fork 0
Commands
Complete reference for all DoPlan CLI commands. Commands are used within your IDE to interact with the AI agent system.
DoPlan CLI uses a slash-command system (/command) that activates specific AI agents to help with your project. Commands are organized into three categories:
- Core Commands - Essential commands for the development workflow
- Team Commands - Commands for managing and viewing agents
- Specialized Commands - Domain-specific commands for advanced use cases
Description: Capture your project idea and save it to the project plan.
Usage:
/tell
/tell <idea>Examples:
/tell
/tell Build a todo app with authentication and dark mode
/tell Create a REST API for a blog platformWhat it does:
- Captures your project idea (inline or prompts for it)
- Saves to
.plan/00_System/IDEA.md - Activates Project Orchestrator and Product Manager
- Updates project state
Files Modified:
.plan/00_System/IDEA.md.plan/active_state.json
Agents Involved:
- Project Orchestrator
- Product Manager
Next Steps: After capturing your idea, use /improve to brainstorm.
Description: Get ideas and improvements from all Level 1 managers.
Usage:
/improveExamples:
/improveWhat it does:
- Activates all Level 1 managers (Product, Engineering, Design, QA, Release, Documentation)
- Conducts a brainstorm session
- Saves all ideas to
.plan/00_System/BRAINSTORM.md
Files Read:
.plan/00_System/IDEA.md
Files Modified:
.plan/00_System/BRAINSTORM.md
Agents Involved:
- Product Manager
- Engineering Lead
- Design & UX Manager
- QA & Reliability Manager
- Release & Growth Manager
- Documentation Lead
Next Steps: Review BRAINSTORM.md, then use /write to generate planning documents.
Description: Generate comprehensive planning documents (PRD, Architecture, Design System).
Usage:
/writeExamples:
/writeWhat it does:
- Product Manager creates PRD.md
- Engineering Lead and System Architect create ARCHITECTURE.md
- Design Manager and UI/UX Designer create DESIGN_SYSTEM.md
- Saves all documents to
.plan/00_System/
Files Read:
.plan/00_System/IDEA.md.plan/00_System/BRAINSTORM.md
Files Modified:
.plan/00_System/PRD.md.plan/00_System/ARCHITECTURE.md.plan/00_System/DESIGN_SYSTEM.md.plan/active_state.json
Agents Involved:
- Product Manager
- Engineering Lead
- System Architect
- Design & UX Manager
- UI/UX Designer
- Project Orchestrator
Next Steps: Review the documents, use /change to edit, or /good to approve.
Description: Edit any planning document with natural language instructions.
Usage:
/change <document> <change>Examples:
/change prd Add dark mode support
/change architecture Use PostgreSQL instead of MySQL
/change design Add mobile-first responsive designWhat it does:
- Parses the document name and change description
- Loads the specified document
- Applies the requested changes
- Saves the updated document
Files Read:
.plan/00_System/*.md
Files Modified:
-
.plan/00_System/*.md(specified document)
Agents Involved:
- Project Orchestrator
Document Names:
-
prd- Product Requirements Document -
architecture- Technical Architecture -
design- Design System
Description: Approve the planning documents and lock them for task generation.
Usage:
/goodExamples:
/goodWhat it does:
- Validates that PRD.md, ARCHITECTURE.md, and DESIGN_SYSTEM.md exist
- Sets
locked: truein active_state.json - Updates phase to "approved"
Files Read:
.plan/00_System/PRD.md.plan/00_System/ARCHITECTURE.md.plan/00_System/DESIGN_SYSTEM.md.plan/active_state.json
Files Modified:
.plan/active_state.json
Agents Involved:
- Project Orchestrator
Next Steps: Use /tasks to generate implementation tasks.
Description: Generate organized implementation tasks from the approved plan.
Usage:
/tasksExamples:
/tasksWhat it does:
- Reads the approved plan (PRD, Architecture, Design System)
- Generates implementation tasks organized by phases
- Creates
.plan/TASKS.md - Updates phase to "tasks"
Files Read:
.plan/00_System/PRD.md.plan/00_System/ARCHITECTURE.md.plan/00_System/DESIGN_SYSTEM.md.plan/active_state.json
Files Modified:
.plan/TASKS.md.plan/active_state.json
Agents Involved:
- Project Orchestrator
- Engineering Lead
- Product Manager
Next Steps: Review TASKS.md, then use /build to start coding.
Description: Start implementing the next task or a specific task.
Usage:
/build
/build <task_id>Examples:
/build
/build 1.2
/build 3What it does:
- Determines the task (next uncompleted or specific task_id)
- Loads task context, dependencies, and related code
- Activates relevant agents (Frontend Lead, Backend Lead, etc.)
- Begins implementation
- Updates active_task in active_state.json
Files Read:
.plan/TASKS.md.plan/active_state.json
Files Modified:
.plan/active_state.json- Source code files
Agents Involved:
- Engineering Lead
- Project Orchestrator
- Relevant team leads (based on task)
GitHub Automation: After task completion, changes are auto-committed and pushed.
Next Steps: Complete the task, then use /finished to mark it complete.
Description: Show current project progress and status.
Usage:
/progressExamples:
/progressWhat it does:
- Reads TASKS.md and active_state.json
- Calculates progress metrics:
- Total tasks
- Completed tasks
- In progress tasks
- Percentage complete
- Displays formatted progress report
Files Read:
.plan/TASKS.md.plan/active_state.json
Agents Involved:
- Project Orchestrator
Output Example:
Phase: building
Tasks: 15/30 completed (50%)
Current task: 1.2 - Create API endpoints
Next up: 1.3 - Implement authentication
Description: Mark the current task as complete and auto-commit changes.
Usage:
/finishedExamples:
/finishedWhat it does:
- Marks task complete in TASKS.md
- Updates active_state.json (removes active_task, adds to completed)
- Auto-commits changes with conventional commit format
- Auto-pushes to current branch
- Updates CHANGELOG.md if significant changes
Files Read:
.plan/TASKS.md.plan/active_state.json
Files Modified:
.plan/TASKS.md.plan/active_state.json- CHANGELOG.md (if applicable)
Agents Involved:
- Project Orchestrator
- Release Captain
GitHub Automation:
- Auto-commit with conventional commit format
- Auto-push to current branch (feature/bugfix/hotfix)
- Update CHANGELOG.md
- Follow branching strategy
Next Steps: Use /build to start the next task.
Description: Display the hierarchical structure of all AI agents and their roles.
Usage:
/teamExamples:
/teamWhat it does:
- Loads all agent definitions from
.cursor/agents/ - Displays the hierarchical structure
- Shows each agent's role and responsibilities
Files Read:
.cursor/agents/*.md
Agents Involved: None (display only)
Output: Shows the complete agent hierarchy with roles.
Description: Load rules or files into agent context for the current session.
Usage:
/load <path>Examples:
/load @library/04-frameworks/nextjs.md
/load .plan/00_System/PRD.md
/load @library/07-databases/postgresql.mdWhat it does:
- Parses the file or directory path
- Loads the content
- Injects it into agent context for the current session
Files Read:
.cursor/rules/library/**.plan/**
Agents Involved:
- Project Orchestrator
Use Cases:
- Load framework-specific rules
- Load database rules
- Load planning documents for reference
- Load custom rules
Description: Manage releases, versioning, and deployment.
Usage:
/shipExamples:
/shipWhat it does:
- Coordinates release process
- Manages versioning
- Handles deployment workflows
Agents Involved:
- Release Captain
- Release & Growth Manager
Description: Perform security audit and review.
Usage:
/safeExamples:
/safeWhat it does:
- Reviews code for security issues
- Checks for vulnerabilities
- Provides security recommendations
Agents Involved:
- Security Lead
Description: Optimize costs and resource usage.
Usage:
/cheapExamples:
/cheapWhat it does:
- Analyzes resource usage
- Identifies cost optimization opportunities
- Provides recommendations
Agents Involved:
- DevOps Engineer
- Performance Engineer
Follow this order for best results:
-
/tell- Capture idea -
/improve- Brainstorm -
/write- Generate plans -
/good- Approve -
/tasks- Generate tasks -
/build- Start coding -
/finished- Complete tasks
Be specific with your change requests:
- ✅ Good:
/change prd Add user authentication with OAuth2 - ❌ Bad:
/change prd fix it
You can build any task by ID:
/build 1.2 # Build task 1.2
/build 3.5 # Build task 3.5Load relevant rules before building:
/load @library/04-frameworks/nextjs.md
/buildCheck progress regularly:
/progressYou can use multiple commands in sequence:
/tell Build a blog
/improve
/write
/good
/tasks
/build/command [arguments]
- Required arguments: Must be provided
- Optional arguments: Can be omitted
- Inline arguments: Can be provided inline or prompted
# No arguments
/tell
/improve
/write
# With inline arguments
/tell Build a todo app
/change prd Add dark mode
# With task ID
/build 1.2| Command | Category | Arguments | Auto-commit |
|---|---|---|---|
/tell |
Core | Optional: idea | No |
/improve |
Core | None | No |
/write |
Core | None | No |
/change |
Core | Required: doc, change | No |
/good |
Core | None | No |
/tasks |
Core | None | No |
/build |
Core | Optional: task_id | No |
/progress |
Core | None | No |
/finished |
Core | None | Yes |
/team |
Team | None | No |
/load |
Team | Required: path | No |
/ship |
Specialized | None | No |
/safe |
Specialized | None | No |
/cheap |
Specialized | None | No |
- Workflow Guide - Complete development workflow
- Agents Documentation - Understanding AI agents
- Quick Start - Getting started guide
- FAQ - Frequently asked questions
- Home - Wiki home page
Last Updated: 2025
Maintained By: Documentation Team