claude-task-master/docs/command-reference.md

212 lines
4.9 KiB
Markdown
Raw Normal View History

2025-04-09 00:16:43 +02:00
# Task Master Command Reference
Here's a comprehensive reference of all available commands:
## Parse PRD
```bash
# Parse a PRD file and generate tasks
task-master parse-prd <prd-file.txt>
# Limit the number of tasks generated
task-master parse-prd <prd-file.txt> --num-tasks=10
```
## List Tasks
```bash
# List all tasks
task-master list
# List tasks with a specific status
task-master list --status=<status>
# List tasks with subtasks
task-master list --with-subtasks
# List tasks with a specific status and include subtasks
task-master list --status=<status> --with-subtasks
```
## Show Next Task
```bash
# Show the next task to work on based on dependencies and status
task-master next
```
## Show Specific Task
```bash
# Show details of a specific task
task-master show <id>
# or
task-master show --id=<id>
# View a specific subtask (e.g., subtask 2 of task 1)
task-master show 1.2
```
## Update Tasks
```bash
# Update tasks from a specific ID and provide context
task-master update --from=<id> --prompt="<prompt>"
docs: Update documentation for new AI/config architecture and finalize cleanup This commit updates all relevant documentation (READMEs, docs/*, .cursor/rules) to accurately reflect the finalized unified AI service architecture and the new configuration system (.taskmasterconfig + .env/mcp.json). It also includes the final code cleanup steps related to the refactoring. Key Changes: 1. **Documentation Updates:** * Revised `README.md`, `README-task-master.md`, `assets/scripts_README.md`, `docs/configuration.md`, and `docs/tutorial.md` to explain the new configuration split (.taskmasterconfig vs .env/mcp.json). * Updated MCP configuration examples in READMEs and tutorials to only include API keys in the `env` block. * Added/updated examples for using the `--research` flag in `docs/command-reference.md`, `docs/examples.md`, and `docs/tutorial.md`. * Updated `.cursor/rules/ai_services.mdc`, `.cursor/rules/architecture.mdc`, `.cursor/rules/dev_workflow.mdc`, `.cursor/rules/mcp.mdc`, `.cursor/rules/taskmaster.mdc`, `.cursor/rules/utilities.mdc`, and `.cursor/rules/new_features.mdc` to align with the new architecture, removing references to old patterns/files. * Removed internal rule links from user-facing rules (`taskmaster.mdc`, `dev_workflow.mdc`, `self_improve.mdc`). * Deleted outdated example file `docs/ai-client-utils-example.md`. 2. **Final Code Refactor & Cleanup:** * Corrected `update-task-by-id.js` by removing the last import from the old `ai-services.js`. * Refactored `update-subtask-by-id.js` to correctly use the unified service and logger patterns. * Removed the obsolete export block from `mcp-server/src/core/task-master-core.js`. * Corrected logger implementation in `update-tasks.js` for CLI context. * Updated API key mapping in `config-manager.js` and `ai-services-unified.js`. 3. **Configuration Files:** * Updated API keys in `.cursor/mcp.json`, replacing `GROK_API_KEY` with `XAI_API_KEY`. * Updated `.env.example` with current API key names. * Added `azureOpenaiBaseUrl` to `.taskmasterconfig` example. 4. **Task Management:** * Marked documentation subtask 61.10 as 'done'. * Includes various other task content/status updates from the diff summary. 5. **Changeset:** * Added `.changeset/cuddly-zebras-matter.md` for user-facing `expand`/`expand-all` improvements. This commit concludes the major architectural refactoring (Task 61) and ensures the documentation accurately reflects the current system.
2025-04-25 14:43:12 -04:00
# Update tasks using research role
task-master update --from=<id> --prompt="<prompt>" --research
2025-04-09 00:16:43 +02:00
```
## Update a Specific Task
```bash
# Update a single task by ID with new information
task-master update-task --id=<id> --prompt="<prompt>"
docs: Update documentation for new AI/config architecture and finalize cleanup This commit updates all relevant documentation (READMEs, docs/*, .cursor/rules) to accurately reflect the finalized unified AI service architecture and the new configuration system (.taskmasterconfig + .env/mcp.json). It also includes the final code cleanup steps related to the refactoring. Key Changes: 1. **Documentation Updates:** * Revised `README.md`, `README-task-master.md`, `assets/scripts_README.md`, `docs/configuration.md`, and `docs/tutorial.md` to explain the new configuration split (.taskmasterconfig vs .env/mcp.json). * Updated MCP configuration examples in READMEs and tutorials to only include API keys in the `env` block. * Added/updated examples for using the `--research` flag in `docs/command-reference.md`, `docs/examples.md`, and `docs/tutorial.md`. * Updated `.cursor/rules/ai_services.mdc`, `.cursor/rules/architecture.mdc`, `.cursor/rules/dev_workflow.mdc`, `.cursor/rules/mcp.mdc`, `.cursor/rules/taskmaster.mdc`, `.cursor/rules/utilities.mdc`, and `.cursor/rules/new_features.mdc` to align with the new architecture, removing references to old patterns/files. * Removed internal rule links from user-facing rules (`taskmaster.mdc`, `dev_workflow.mdc`, `self_improve.mdc`). * Deleted outdated example file `docs/ai-client-utils-example.md`. 2. **Final Code Refactor & Cleanup:** * Corrected `update-task-by-id.js` by removing the last import from the old `ai-services.js`. * Refactored `update-subtask-by-id.js` to correctly use the unified service and logger patterns. * Removed the obsolete export block from `mcp-server/src/core/task-master-core.js`. * Corrected logger implementation in `update-tasks.js` for CLI context. * Updated API key mapping in `config-manager.js` and `ai-services-unified.js`. 3. **Configuration Files:** * Updated API keys in `.cursor/mcp.json`, replacing `GROK_API_KEY` with `XAI_API_KEY`. * Updated `.env.example` with current API key names. * Added `azureOpenaiBaseUrl` to `.taskmasterconfig` example. 4. **Task Management:** * Marked documentation subtask 61.10 as 'done'. * Includes various other task content/status updates from the diff summary. 5. **Changeset:** * Added `.changeset/cuddly-zebras-matter.md` for user-facing `expand`/`expand-all` improvements. This commit concludes the major architectural refactoring (Task 61) and ensures the documentation accurately reflects the current system.
2025-04-25 14:43:12 -04:00
# Use research-backed updates
2025-04-09 00:16:43 +02:00
task-master update-task --id=<id> --prompt="<prompt>" --research
```
## Update a Subtask
```bash
# Append additional information to a specific subtask
task-master update-subtask --id=<parentId.subtaskId> --prompt="<prompt>"
# Example: Add details about API rate limiting to subtask 2 of task 5
task-master update-subtask --id=5.2 --prompt="Add rate limiting of 100 requests per minute"
docs: Update documentation for new AI/config architecture and finalize cleanup This commit updates all relevant documentation (READMEs, docs/*, .cursor/rules) to accurately reflect the finalized unified AI service architecture and the new configuration system (.taskmasterconfig + .env/mcp.json). It also includes the final code cleanup steps related to the refactoring. Key Changes: 1. **Documentation Updates:** * Revised `README.md`, `README-task-master.md`, `assets/scripts_README.md`, `docs/configuration.md`, and `docs/tutorial.md` to explain the new configuration split (.taskmasterconfig vs .env/mcp.json). * Updated MCP configuration examples in READMEs and tutorials to only include API keys in the `env` block. * Added/updated examples for using the `--research` flag in `docs/command-reference.md`, `docs/examples.md`, and `docs/tutorial.md`. * Updated `.cursor/rules/ai_services.mdc`, `.cursor/rules/architecture.mdc`, `.cursor/rules/dev_workflow.mdc`, `.cursor/rules/mcp.mdc`, `.cursor/rules/taskmaster.mdc`, `.cursor/rules/utilities.mdc`, and `.cursor/rules/new_features.mdc` to align with the new architecture, removing references to old patterns/files. * Removed internal rule links from user-facing rules (`taskmaster.mdc`, `dev_workflow.mdc`, `self_improve.mdc`). * Deleted outdated example file `docs/ai-client-utils-example.md`. 2. **Final Code Refactor & Cleanup:** * Corrected `update-task-by-id.js` by removing the last import from the old `ai-services.js`. * Refactored `update-subtask-by-id.js` to correctly use the unified service and logger patterns. * Removed the obsolete export block from `mcp-server/src/core/task-master-core.js`. * Corrected logger implementation in `update-tasks.js` for CLI context. * Updated API key mapping in `config-manager.js` and `ai-services-unified.js`. 3. **Configuration Files:** * Updated API keys in `.cursor/mcp.json`, replacing `GROK_API_KEY` with `XAI_API_KEY`. * Updated `.env.example` with current API key names. * Added `azureOpenaiBaseUrl` to `.taskmasterconfig` example. 4. **Task Management:** * Marked documentation subtask 61.10 as 'done'. * Includes various other task content/status updates from the diff summary. 5. **Changeset:** * Added `.changeset/cuddly-zebras-matter.md` for user-facing `expand`/`expand-all` improvements. This commit concludes the major architectural refactoring (Task 61) and ensures the documentation accurately reflects the current system.
2025-04-25 14:43:12 -04:00
# Use research-backed updates
2025-04-09 00:16:43 +02:00
task-master update-subtask --id=<parentId.subtaskId> --prompt="<prompt>" --research
```
Unlike the `update-task` command which replaces task information, the `update-subtask` command _appends_ new information to the existing subtask details, marking it with a timestamp. This is useful for iteratively enhancing subtasks while preserving the original content.
## Generate Task Files
```bash
# Generate individual task files from tasks.json
task-master generate
```
## Set Task Status
```bash
# Set status of a single task
task-master set-status --id=<id> --status=<status>
# Set status for multiple tasks
task-master set-status --id=1,2,3 --status=<status>
# Set status for subtasks
task-master set-status --id=1.1,1.2 --status=<status>
```
When marking a task as "done", all of its subtasks will automatically be marked as "done" as well.
## Expand Tasks
```bash
# Expand a specific task with subtasks
task-master expand --id=<id> --num=<number>
# Expand with additional context
task-master expand --id=<id> --prompt="<context>"
# Expand all pending tasks
task-master expand --all
# Force regeneration of subtasks for tasks that already have them
task-master expand --all --force
# Research-backed subtask generation for a specific task
task-master expand --id=<id> --research
# Research-backed generation for all tasks
task-master expand --all --research
```
## Clear Subtasks
```bash
# Clear subtasks from a specific task
task-master clear-subtasks --id=<id>
# Clear subtasks from multiple tasks
task-master clear-subtasks --id=1,2,3
# Clear subtasks from all tasks
task-master clear-subtasks --all
```
## Analyze Task Complexity
```bash
# Analyze complexity of all tasks
task-master analyze-complexity
# Save report to a custom location
task-master analyze-complexity --output=my-report.json
# Use a specific LLM model
task-master analyze-complexity --model=claude-3-opus-20240229
# Set a custom complexity threshold (1-10)
task-master analyze-complexity --threshold=6
# Use an alternative tasks file
task-master analyze-complexity --file=custom-tasks.json
# Use Perplexity AI for research-backed complexity analysis
task-master analyze-complexity --research
```
## View Complexity Report
```bash
# Display the task complexity analysis report
task-master complexity-report
# View a report at a custom location
task-master complexity-report --file=my-report.json
```
## Managing Task Dependencies
```bash
# Add a dependency to a task
task-master add-dependency --id=<id> --depends-on=<id>
# Remove a dependency from a task
task-master remove-dependency --id=<id> --depends-on=<id>
# Validate dependencies without fixing them
task-master validate-dependencies
# Find and fix invalid dependencies automatically
task-master fix-dependencies
```
## Add a New Task
```bash
docs: Update documentation for new AI/config architecture and finalize cleanup This commit updates all relevant documentation (READMEs, docs/*, .cursor/rules) to accurately reflect the finalized unified AI service architecture and the new configuration system (.taskmasterconfig + .env/mcp.json). It also includes the final code cleanup steps related to the refactoring. Key Changes: 1. **Documentation Updates:** * Revised `README.md`, `README-task-master.md`, `assets/scripts_README.md`, `docs/configuration.md`, and `docs/tutorial.md` to explain the new configuration split (.taskmasterconfig vs .env/mcp.json). * Updated MCP configuration examples in READMEs and tutorials to only include API keys in the `env` block. * Added/updated examples for using the `--research` flag in `docs/command-reference.md`, `docs/examples.md`, and `docs/tutorial.md`. * Updated `.cursor/rules/ai_services.mdc`, `.cursor/rules/architecture.mdc`, `.cursor/rules/dev_workflow.mdc`, `.cursor/rules/mcp.mdc`, `.cursor/rules/taskmaster.mdc`, `.cursor/rules/utilities.mdc`, and `.cursor/rules/new_features.mdc` to align with the new architecture, removing references to old patterns/files. * Removed internal rule links from user-facing rules (`taskmaster.mdc`, `dev_workflow.mdc`, `self_improve.mdc`). * Deleted outdated example file `docs/ai-client-utils-example.md`. 2. **Final Code Refactor & Cleanup:** * Corrected `update-task-by-id.js` by removing the last import from the old `ai-services.js`. * Refactored `update-subtask-by-id.js` to correctly use the unified service and logger patterns. * Removed the obsolete export block from `mcp-server/src/core/task-master-core.js`. * Corrected logger implementation in `update-tasks.js` for CLI context. * Updated API key mapping in `config-manager.js` and `ai-services-unified.js`. 3. **Configuration Files:** * Updated API keys in `.cursor/mcp.json`, replacing `GROK_API_KEY` with `XAI_API_KEY`. * Updated `.env.example` with current API key names. * Added `azureOpenaiBaseUrl` to `.taskmasterconfig` example. 4. **Task Management:** * Marked documentation subtask 61.10 as 'done'. * Includes various other task content/status updates from the diff summary. 5. **Changeset:** * Added `.changeset/cuddly-zebras-matter.md` for user-facing `expand`/`expand-all` improvements. This commit concludes the major architectural refactoring (Task 61) and ensures the documentation accurately reflects the current system.
2025-04-25 14:43:12 -04:00
# Add a new task using AI (main role)
2025-04-09 00:16:43 +02:00
task-master add-task --prompt="Description of the new task"
docs: Update documentation for new AI/config architecture and finalize cleanup This commit updates all relevant documentation (READMEs, docs/*, .cursor/rules) to accurately reflect the finalized unified AI service architecture and the new configuration system (.taskmasterconfig + .env/mcp.json). It also includes the final code cleanup steps related to the refactoring. Key Changes: 1. **Documentation Updates:** * Revised `README.md`, `README-task-master.md`, `assets/scripts_README.md`, `docs/configuration.md`, and `docs/tutorial.md` to explain the new configuration split (.taskmasterconfig vs .env/mcp.json). * Updated MCP configuration examples in READMEs and tutorials to only include API keys in the `env` block. * Added/updated examples for using the `--research` flag in `docs/command-reference.md`, `docs/examples.md`, and `docs/tutorial.md`. * Updated `.cursor/rules/ai_services.mdc`, `.cursor/rules/architecture.mdc`, `.cursor/rules/dev_workflow.mdc`, `.cursor/rules/mcp.mdc`, `.cursor/rules/taskmaster.mdc`, `.cursor/rules/utilities.mdc`, and `.cursor/rules/new_features.mdc` to align with the new architecture, removing references to old patterns/files. * Removed internal rule links from user-facing rules (`taskmaster.mdc`, `dev_workflow.mdc`, `self_improve.mdc`). * Deleted outdated example file `docs/ai-client-utils-example.md`. 2. **Final Code Refactor & Cleanup:** * Corrected `update-task-by-id.js` by removing the last import from the old `ai-services.js`. * Refactored `update-subtask-by-id.js` to correctly use the unified service and logger patterns. * Removed the obsolete export block from `mcp-server/src/core/task-master-core.js`. * Corrected logger implementation in `update-tasks.js` for CLI context. * Updated API key mapping in `config-manager.js` and `ai-services-unified.js`. 3. **Configuration Files:** * Updated API keys in `.cursor/mcp.json`, replacing `GROK_API_KEY` with `XAI_API_KEY`. * Updated `.env.example` with current API key names. * Added `azureOpenaiBaseUrl` to `.taskmasterconfig` example. 4. **Task Management:** * Marked documentation subtask 61.10 as 'done'. * Includes various other task content/status updates from the diff summary. 5. **Changeset:** * Added `.changeset/cuddly-zebras-matter.md` for user-facing `expand`/`expand-all` improvements. This commit concludes the major architectural refactoring (Task 61) and ensures the documentation accurately reflects the current system.
2025-04-25 14:43:12 -04:00
# Add a new task using AI (research role)
task-master add-task --prompt="Description of the new task" --research
2025-04-09 00:16:43 +02:00
# Add a task with dependencies
task-master add-task --prompt="Description" --dependencies=1,2,3
# Add a task with priority
task-master add-task --prompt="Description" --priority=high
```
## Initialize a Project
```bash
# Initialize a new project with Task Master structure
task-master init
```