PAELLADOC Commands
Complete guide to all commands available in PAELLADOC and how to use them
Main Commands
PAELLA
Initiates the documentation process and generates Cursor rules.
Usage:
PAELLA project_name
Arguments:
project_name
- Name of the project to document (required)generate_rules
- Whether to generate Cursor rules from documentation (default: true)ai_mode
- AI operation mode: "autonomous", "collaborative", or "advisory" (default: "collaborative")
Example:
PAELLA my_project
CONTINUE
Continues with an existing project documentation.
Usage:
CONTINUE project_name
Arguments:
project_name
- Name of the project to continue with (required)update_rules
- Whether to update Cursor rules from documentation (default: true)sync_templates
- Whether to synchronize templates with current state (default: true)
Example:
CONTINUE my_project
Project Management Commands
ACHIEVEMENT
Records an achievement in the project memory.
Usage:
ACHIEVEMENT description category [impact_level]
Arguments:
description
- Description of the achievement (required)category
- Category of the achievement (required): architecture, development, documentation, testing, security, performance, product, design, researchimpact_level
- Level of impact of the achievement (default: "medium"): high, medium, low
Example:
ACHIEVEMENT "Implemented responsive design" design high
ISSUE
Records an issue in the project memory.
Usage:
ISSUE description severity area
Arguments:
description
- Description of the issue (required)severity
- Severity level of the issue (required): critical, high, medium, lowarea
- Area affected by the issue (required): product, technical, process, security, performance
Example:
ISSUE "Login page not responsive on mobile" high product
DECISION
Records a technical decision in the project memory.
Usage:
DECISION description impact rationale
Arguments:
description
- Description of the decision (required)impact
- Areas impacted by the decision (required): architecture, development, documentation, testing, security, performance, product, design, processrationale
- Reasoning behind the decision (required)
Example:
DECISION "Use React for frontend" "architecture,development" "Better component reusability and ecosystem"
Research and Verification Commands
RESEARCH
Performs automatic research for a specific topic.
Usage:
RESEARCH topic depth project_name
Arguments:
topic
- Topic to research (required)depth
- Research depth level (default: "standard"): basic, standard, exhaustiveproject_name
- Project to associate research with (required)
Example:
RESEARCH "React state management" exhaustive my_project
VERIFY
Verifies an information source.
Usage:
VERIFY source type [reliability]
Arguments:
source
- URL or reference of the source to verify (required)type
- Type of source (required): academic, technical, blog, documentation, market_research, user_researchreliability
- Required reliability level (default: "high"): high, medium, low
Example:
VERIFY "https://reactjs.org/docs/hooks-intro.html" documentation high
Documentation Management Commands
MEMORY
Shows the development record.
Usage:
MEMORY [filter] [format]
Arguments:
filter
- Filter memory by category (default: "all"): all, achievements, issues, decisions, product, technicalformat
- Output format (default: "detailed"): detailed, summary, timeline
Example:
MEMORY decisions timeline
GENERATE_RULES
Generates or updates Cursor rules from documentation.
Usage:
GENERATE_RULES project_name [rule_type]
Arguments:
project_name
- Name of the project (required)rule_type
- Types of rules to generate (default: ["all"]): product, technical, process, security, all
Example:
GENERATE_RULES my_project technical,security
TEMPLATE
Manages documentation templates.
Usage:
TEMPLATE operation template_type [template_name]
Arguments:
operation
- Template operation to perform (required): create, update, delete, list, synctemplate_type
- Type of template (required): product, technical, process, simplifiedtemplate_name
- Name of the template (optional)
Example:
TEMPLATE list technical
Advanced Commands
FORCE_RESEARCH
Forces automatic deep research for a document without asking any questions.
Usage:
FORCE_RESEARCH project_name document [force_level]
Arguments:
project_name
- Name of the project (required)document
- Document to research (e.g., 01_market_research.md) (required)force_level
- Level of force to apply to research (default: "high"): normal, high, maximum
Example:
FORCE_RESEARCH my_project 01_market_research.md maximum
UPDATE_ADR
Updates the Architecture Decision Record based on recent changes.
Usage:
UPDATE_ADR project_name [auto_detect] [update_status]
Arguments:
project_name
- Name of the project to update ADR for (required)auto_detect
- Whether to automatically detect architectural changes (default: true)update_status
- Whether to update status of existing decisions (default: true)
Example:
UPDATE_ADR my_project true true
GENERATE_MDC
Generates a Cursor MDC file from project documentation for development.
Usage:
GENERATE_MDC project_name [output_path] [include_rules]
Arguments:
project_name
- Name of the project to generate MDC for (required)output_path
- Path where to save the MDC file (default: "docs/${project_name}/")include_rules
- Whether to extract development rules from documentation (default: true)
Example:
GENERATE_MDC my_project "docs/my_project/" true