Compare commits

...

1 Commits

Author SHA1 Message Date
github-actions[bot]
8d1d82c897 docs: auto-update documentation based on changes in next branch
This PR was automatically generated to update documentation based on recent changes.

  Original commit: fix: improve docs and command help for analzye-complexity (#1235)\n\n\n

  Co-authored-by: Claude <claude-assistant@anthropic.com>
2025-09-23 16:34:00 +00:00
14 changed files with 214 additions and 43 deletions

View File

@@ -58,9 +58,9 @@ Examples:
```md ```md
# Good # Good
Added new `--research` flag to the `expand` command that uses Perplexity AI Added new `--research` flag to the `expand` command that uses your configured research model
to provide research-backed task expansions. Requires PERPLEXITY_API_KEY to provide research-backed task expansions. Requires appropriate API key
environment variable. for your research model.
# Not Good # Not Good

View File

@@ -16,7 +16,7 @@ task-master analyze-complexity [--research] [--threshold=5]
## Analysis Parameters ## Analysis Parameters
- `--research` → Use research AI for deeper analysis - `--research` → Use configured research model for deeper analysis
- `--threshold=5` → Only flag tasks above complexity 5 - `--threshold=5` → Only flag tasks above complexity 5
- Default: Analyze all pending tasks - Default: Analyze all pending tasks

View File

@@ -231,7 +231,7 @@ Taskmaster offers two primary ways to interact:
- Use `expand_task` / `task-master expand --id=<id>`. It automatically uses the complexity report if found, otherwise generates default number of subtasks. - Use `expand_task` / `task-master expand --id=<id>`. It automatically uses the complexity report if found, otherwise generates default number of subtasks.
- Use `--num=<number>` to specify an explicit number of subtasks, overriding defaults or complexity report recommendations. - Use `--num=<number>` to specify an explicit number of subtasks, overriding defaults or complexity report recommendations.
- Add `--research` flag to leverage Perplexity AI for research-backed expansion. - Add `--research` flag to leverage your configured research model for research-backed expansion.
- Add `--force` flag to clear existing subtasks before generating new ones (default is to append). - Add `--force` flag to clear existing subtasks before generating new ones (default is to append).
- Use `--prompt="<context>"` to provide additional context when needed. - Use `--prompt="<context>"` to provide additional context when needed.
- Review and adjust generated subtasks as necessary. - Review and adjust generated subtasks as necessary.

View File

@@ -229,7 +229,7 @@ Taskmaster offers two primary ways to interact:
- Use `expand_task` / `task-master expand --id=<id>`. It automatically uses the complexity report if found, otherwise generates default number of subtasks. - Use `expand_task` / `task-master expand --id=<id>`. It automatically uses the complexity report if found, otherwise generates default number of subtasks.
- Use `--num=<number>` to specify an explicit number of subtasks, overriding defaults or complexity report recommendations. - Use `--num=<number>` to specify an explicit number of subtasks, overriding defaults or complexity report recommendations.
- Add `--research` flag to leverage Perplexity AI for research-backed expansion. - Add `--research` flag to leverage your configured research model for research-backed expansion.
- Add `--force` flag to clear existing subtasks before generating new ones (default is to append). - Add `--force` flag to clear existing subtasks before generating new ones (default is to append).
- Use `--prompt="<context>"` to provide additional context when needed. - Use `--prompt="<context>"` to provide additional context when needed.
- Review and adjust generated subtasks as necessary. - Review and adjust generated subtasks as necessary.

View File

@@ -12,7 +12,7 @@ In an AI-driven development process—particularly with tools like [Cursor](http
4. **Generate** individual task files (e.g., `task_001.txt`) for easy reference or to feed into an AI coding workflow. 4. **Generate** individual task files (e.g., `task_001.txt`) for easy reference or to feed into an AI coding workflow.
5. **Set task status**—mark tasks as `done`, `pending`, or `deferred` based on progress. 5. **Set task status**—mark tasks as `done`, `pending`, or `deferred` based on progress.
6. **Expand** tasks with subtasks—break down complex tasks into smaller, more manageable subtasks. 6. **Expand** tasks with subtasks—break down complex tasks into smaller, more manageable subtasks.
7. **Research-backed subtask generation**—use Perplexity AI to generate more informed and contextually relevant subtasks. 7. **Research-backed subtask generation**—use your configured research model to generate more informed and contextually relevant subtasks.
8. **Clear subtasks**—remove subtasks from specified tasks to allow regeneration or restructuring. 8. **Clear subtasks**—remove subtasks from specified tasks to allow regeneration or restructuring.
9. **Show task details**—display detailed information about a specific task and its subtasks. 9. **Show task details**—display detailed information about a specific task and its subtasks.
@@ -29,7 +29,7 @@ The script can be configured through environment variables in a `.env` file at t
- `MODEL`: Specify which Claude model to use (default: "claude-3-7-sonnet-20250219") - `MODEL`: Specify which Claude model to use (default: "claude-3-7-sonnet-20250219")
- `MAX_TOKENS`: Maximum tokens for model responses (default: 4000) - `MAX_TOKENS`: Maximum tokens for model responses (default: 4000)
- `TEMPERATURE`: Temperature for model responses (default: 0.7) - `TEMPERATURE`: Temperature for model responses (default: 0.7)
- `PERPLEXITY_API_KEY`: Your Perplexity API key for research-backed subtask generation - `PERPLEXITY_API_KEY`: Your Perplexity API key for research-backed subtask generation (if using Perplexity as your research model)
- `PERPLEXITY_MODEL`: Specify which Perplexity model to use (default: "sonar-medium-online") - `PERPLEXITY_MODEL`: Specify which Perplexity model to use (default: "sonar-medium-online")
- `DEBUG`: Enable debug logging (default: false) - `DEBUG`: Enable debug logging (default: false)
- `TASKMASTER_LOG_LEVEL`: Log level - debug, info, warn, error (default: info) - `TASKMASTER_LOG_LEVEL`: Log level - debug, info, warn, error (default: info)
@@ -97,7 +97,7 @@ node scripts/dev.js update --from=4 --prompt="Refactor tasks from ID 4 onward to
# Update all tasks (default from=1) # Update all tasks (default from=1)
node scripts/dev.js update --prompt="Add authentication to all relevant tasks" node scripts/dev.js update --prompt="Add authentication to all relevant tasks"
# With research-backed updates using Perplexity AI # With research-backed updates using your configured research model
node scripts/dev.js update --from=4 --prompt="Integrate OAuth 2.0" --research node scripts/dev.js update --from=4 --prompt="Integrate OAuth 2.0" --research
# Specify a different tasks file # Specify a different tasks file
@@ -109,7 +109,7 @@ Notes:
- The `--prompt` parameter is required and should explain the changes or new context - The `--prompt` parameter is required and should explain the changes or new context
- Only tasks that aren't marked as 'done' will be updated - Only tasks that aren't marked as 'done' will be updated
- Tasks with ID >= the specified --from value will be updated - Tasks with ID >= the specified --from value will be updated
- The `--research` flag uses Perplexity AI for more informed updates when available - The `--research` flag uses your configured research model for more informed updates when available
## Updating a Single Task ## Updating a Single Task
@@ -119,7 +119,7 @@ The `update-task` command allows you to update a specific task instead of multip
# Update a specific task with new information # Update a specific task with new information
node scripts/dev.js update-task --id=4 --prompt="Use JWT for authentication" node scripts/dev.js update-task --id=4 --prompt="Use JWT for authentication"
# With research-backed updates using Perplexity AI # With research-backed updates using your configured research model
node scripts/dev.js update-task --id=4 --prompt="Use JWT for authentication" --research node scripts/dev.js update-task --id=4 --prompt="Use JWT for authentication" --research
``` ```
@@ -178,10 +178,10 @@ node scripts/dev.js expand --all
# Force regeneration of subtasks for all pending tasks # Force regeneration of subtasks for all pending tasks
node scripts/dev.js expand --all --force node scripts/dev.js expand --all --force
# Use Perplexity AI for research-backed subtask generation # Use your configured research model for research-backed subtask generation
node scripts/dev.js expand --id=3 --research node scripts/dev.js expand --id=3 --research
# Use Perplexity AI for research-backed generation on all pending tasks # Use your configured research model for research-backed generation on all pending tasks
node scripts/dev.js expand --all --research node scripts/dev.js expand --all --research
``` ```
@@ -211,17 +211,16 @@ Notes:
The script integrates with two AI services: The script integrates with two AI services:
1. **Anthropic Claude**: Used for parsing PRDs, generating tasks, and creating subtasks. 1. **Main AI Model**: Used for parsing PRDs, generating tasks, and creating subtasks (typically Anthropic Claude).
2. **Perplexity AI**: Used for research-backed subtask generation when the `--research` flag is specified. 2. **Research Model**: Used for research-backed subtask generation when the `--research` flag is specified.
The Perplexity integration uses the OpenAI client to connect to Perplexity's API, which provides enhanced research capabilities for generating more informed subtasks. If the Perplexity API is unavailable or encounters an error, the script will automatically fall back to using Anthropic's Claude. The research integration provides enhanced research capabilities for generating more informed subtasks. You can configure different models for research (like Perplexity, which has access to current information) vs. main tasks. If the research model is unavailable or encounters an error, the script will automatically fall back to using your main model.
To use the Perplexity integration: To use research-backed features:
1. Obtain a Perplexity API key 1. Configure your research model using `task-master models --setup`
2. Add `PERPLEXITY_API_KEY` to your `.env` file 2. Ensure you have the appropriate API key in your `.env` file (e.g., `PERPLEXITY_API_KEY` if using Perplexity)
3. Optionally specify `PERPLEXITY_MODEL` in your `.env` file (default: "sonar-medium-online") 3. Use the `--research` flag with supported commands
4. Use the `--research` flag with the `expand` command
## Logging ## Logging
@@ -342,13 +341,13 @@ node scripts/dev.js analyze-complexity --model=claude-3-opus-20240229
# Set a custom complexity threshold (1-10) # Set a custom complexity threshold (1-10)
node scripts/dev.js analyze-complexity --threshold=6 node scripts/dev.js analyze-complexity --threshold=6
# Use Perplexity AI for research-backed complexity analysis # Use your configured research model for research-backed complexity analysis
node scripts/dev.js analyze-complexity --research node scripts/dev.js analyze-complexity --research
``` ```
Notes: Notes:
- The command uses Claude to analyze each task's complexity (or Perplexity with --research flag) - The command uses your main model to analyze each task's complexity (or your configured research model with --research flag)
- Tasks are scored on a scale of 1-10 - Tasks are scored on a scale of 1-10
- Each task receives a recommended number of subtasks based on DEFAULT_SUBTASKS configuration - Each task receives a recommended number of subtasks based on DEFAULT_SUBTASKS configuration
- The default output path is `scripts/task-complexity-report.json` - The default output path is `scripts/task-complexity-report.json`

View File

@@ -301,7 +301,7 @@ The agent will execute:
task-master expand --all task-master expand --all
``` ```
For research-backed subtask generation using Perplexity AI: For research-backed subtask generation using your configured research model:
``` ```
Please break down task 5 using research-backed generation. Please break down task 5 using research-backed generation.
@@ -450,7 +450,7 @@ task-master analyze-complexity --threshold=6
# Use an alternative tasks file # Use an alternative tasks file
task-master analyze-complexity --file=custom-tasks.json task-master analyze-complexity --file=custom-tasks.json
# Use Perplexity AI for research-backed complexity analysis # Use your configured research model for research-backed complexity analysis
task-master analyze-complexity --research task-master analyze-complexity --research
``` ```

View File

@@ -118,7 +118,7 @@ description: "Learn how Task Master and Cursor AI work together to streamline yo
task-master expand --all task-master expand --all
``` ```
For research-backed subtask generation using Perplexity AI: For research-backed subtask generation using configured research model:
``` ```
Please break down task 5 using research-backed generation. Please break down task 5 using research-backed generation.

View File

@@ -61,7 +61,7 @@ description: "A comprehensive reference of all available Task Master commands"
# Update a single task by ID with new information # Update a single task by ID with new information
task-master update-task --id=<id> --prompt="<prompt>" task-master update-task --id=<id> --prompt="<prompt>"
# Use research-backed updates with Perplexity AI # Use research-backed updates with configured research model
task-master update-task --id=<id> --prompt="<prompt>" --research task-master update-task --id=<id> --prompt="<prompt>" --research
``` ```
</Accordion> </Accordion>
@@ -74,7 +74,7 @@ description: "A comprehensive reference of all available Task Master commands"
# Example: Add details about API rate limiting to subtask 2 of task 5 # 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" task-master update-subtask --id=5.2 --prompt="Add rate limiting of 100 requests per minute"
# Use research-backed updates with Perplexity AI # Use research-backed updates with configured research model
task-master update-subtask --id=<parentId.subtaskId> --prompt="<prompt>" --research task-master update-subtask --id=<parentId.subtaskId> --prompt="<prompt>" --research
``` ```
@@ -155,7 +155,7 @@ description: "A comprehensive reference of all available Task Master commands"
# Use an alternative tasks file # Use an alternative tasks file
task-master analyze-complexity --file=custom-tasks.json task-master analyze-complexity --file=custom-tasks.json
# Use Perplexity AI for research-backed complexity analysis # Use configured research model for research-backed complexity analysis
task-master analyze-complexity --research task-master analyze-complexity --research
``` ```
</Accordion> </Accordion>

View File

@@ -181,7 +181,7 @@ task-master analyze-complexity --threshold=6
# Use an alternative tasks file # Use an alternative tasks file
task-master analyze-complexity --file=custom-tasks.json task-master analyze-complexity --file=custom-tasks.json
# Use Perplexity AI for research-backed complexity analysis # Use your configured research model for research-backed complexity analysis
task-master analyze-complexity --research task-master analyze-complexity --research
``` ```

172
output.txt Normal file

File diff suppressed because one or more lines are too long

View File

@@ -60,7 +60,7 @@ alwaysApply: true
- For tasks with complexity analysis, use `node scripts/dev.js expand --id=<id>` - For tasks with complexity analysis, use `node scripts/dev.js expand --id=<id>`
- Otherwise use `node scripts/dev.js expand --id=<id> --subtasks=<number>` - Otherwise use `node scripts/dev.js expand --id=<id> --subtasks=<number>`
- Add `--research` flag to leverage Perplexity AI for research-backed expansion - Add `--research` flag to leverage your configured research model for research-backed expansion
- Use `--prompt="<context>"` to provide additional context when needed - Use `--prompt="<context>"` to provide additional context when needed
- Review and adjust generated subtasks as necessary - Review and adjust generated subtasks as necessary
- Use `--all` flag to expand multiple pending tasks at once - Use `--all` flag to expand multiple pending tasks at once
@@ -160,7 +160,7 @@ alwaysApply: true
- `--id=<id>`: ID of task to expand (required unless using --all) - `--id=<id>`: ID of task to expand (required unless using --all)
- `--all`: Expand all pending tasks, prioritized by complexity - `--all`: Expand all pending tasks, prioritized by complexity
- `--num=<number>`: Number of subtasks to generate (default: from complexity report) - `--num=<number>`: Number of subtasks to generate (default: from complexity report)
- `--research`: Use Perplexity AI for research-backed generation - `--research`: Use your configured research model for research-backed generation
- `--prompt="<text>"`: Additional context for subtask generation - `--prompt="<text>"`: Additional context for subtask generation
- `--force`: Regenerate subtasks even for tasks that already have them - `--force`: Regenerate subtasks even for tasks that already have them
- Example: `task-master expand --id=3 --num=5 --research --prompt="Focus on security aspects"` - Example: `task-master expand --id=3 --num=5 --research --prompt="Focus on security aspects"`
@@ -176,7 +176,7 @@ alwaysApply: true
- `--model=<model>, -m`: Override LLM model to use - `--model=<model>, -m`: Override LLM model to use
- `--threshold=<number>, -t`: Minimum score for expansion recommendation (default: 5) - `--threshold=<number>, -t`: Minimum score for expansion recommendation (default: 5)
- `--file=<path>, -f`: Use alternative tasks.json file - `--file=<path>, -f`: Use alternative tasks.json file
- `--research, -r`: Use Perplexity AI for research-backed analysis - `--research, -r`: Use your configured research model for research-backed analysis
- Example: `task-master analyze-complexity --research` - Example: `task-master analyze-complexity --research`
- Notes: Report includes complexity scores, recommended subtasks, and tailored prompts. - Notes: Report includes complexity scores, recommended subtasks, and tailored prompts.

View File

@@ -16,7 +16,7 @@ task-master analyze-complexity [--research] [--threshold=5]
## Analysis Parameters ## Analysis Parameters
- `--research` → Use research AI for deeper analysis - `--research` → Use configured research model for deeper analysis
- `--threshold=5` → Only flag tasks above complexity 5 - `--threshold=5` → Only flag tasks above complexity 5
- Default: Analyze all pending tasks - Default: Analyze all pending tasks

View File

@@ -231,7 +231,7 @@ Taskmaster offers two primary ways to interact:
- Use `expand_task` / `task-master expand --id=<id>`. It automatically uses the complexity report if found, otherwise generates default number of subtasks. - Use `expand_task` / `task-master expand --id=<id>`. It automatically uses the complexity report if found, otherwise generates default number of subtasks.
- Use `--num=<number>` to specify an explicit number of subtasks, overriding defaults or complexity report recommendations. - Use `--num=<number>` to specify an explicit number of subtasks, overriding defaults or complexity report recommendations.
- Add `--research` flag to leverage Perplexity AI for research-backed expansion. - Add `--research` flag to leverage your configured research model for research-backed expansion.
- Add `--force` flag to clear existing subtasks before generating new ones (default is to append). - Add `--force` flag to clear existing subtasks before generating new ones (default is to append).
- Use `--prompt="<context>"` to provide additional context when needed. - Use `--prompt="<context>"` to provide additional context when needed.
- Review and adjust generated subtasks as necessary. - Review and adjust generated subtasks as necessary.

View File

@@ -12,7 +12,7 @@ In an AI-driven development process—particularly with tools like [Cursor](http
4. **Generate** individual task files (e.g., `task_001.txt`) for easy reference or to feed into an AI coding workflow. 4. **Generate** individual task files (e.g., `task_001.txt`) for easy reference or to feed into an AI coding workflow.
5. **Set task status**—mark tasks as `done`, `pending`, or `deferred` based on progress. 5. **Set task status**—mark tasks as `done`, `pending`, or `deferred` based on progress.
6. **Expand** tasks with subtasks—break down complex tasks into smaller, more manageable subtasks. 6. **Expand** tasks with subtasks—break down complex tasks into smaller, more manageable subtasks.
7. **Research-backed subtask generation**—use Perplexity AI to generate more informed and contextually relevant subtasks. 7. **Research-backed subtask generation**—use your configured research model to generate more informed and contextually relevant subtasks.
8. **Clear subtasks**—remove subtasks from specified tasks to allow regeneration or restructuring. 8. **Clear subtasks**—remove subtasks from specified tasks to allow regeneration or restructuring.
9. **Show task details**—display detailed information about a specific task and its subtasks. 9. **Show task details**—display detailed information about a specific task and its subtasks.
@@ -27,7 +27,7 @@ Task Master configuration is now managed through two primary methods:
- This is the main configuration file for most settings. - This is the main configuration file for most settings.
2. **Environment Variables (`.env` File - API Keys Only)** 2. **Environment Variables (`.env` File - API Keys Only)**
- Used **only** for sensitive **API Keys** (e.g., `ANTHROPIC_API_KEY`, `PERPLEXITY_API_KEY`). - Used **only** for sensitive **API Keys** (e.g., `ANTHROPIC_API_KEY`, `PERPLEXITY_API_KEY`, etc.).
- Create a `.env` file in your project root for CLI usage. - Create a `.env` file in your project root for CLI usage.
- See `assets/env.example` for required key names. - See `assets/env.example` for required key names.
@@ -160,10 +160,10 @@ task-master expand --all
# Force regeneration of subtasks for all pending tasks # Force regeneration of subtasks for all pending tasks
task-master expand --all --force task-master expand --all --force
# Use Perplexity AI for research-backed subtask generation # Use your configured research model for research-backed subtask generation
task-master expand --id=3 --research task-master expand --id=3 --research
# Use Perplexity AI for research-backed generation on all pending tasks # Use your configured research model for research-backed generation on all pending tasks
task-master expand --all --research task-master expand --all --research
``` ```
@@ -192,10 +192,10 @@ Notes:
## AI Integration (Updated) ## AI Integration (Updated)
- The script now uses a unified AI service layer (`ai-services-unified.js`). - The script now uses a unified AI service layer (`ai-services-unified.js`).
- Model selection (e.g., Claude vs. Perplexity for `--research`) is determined by the configuration in `.taskmaster/config.json` based on the requested `role` (`main` or `research`). - Model selection (e.g., Claude vs. research models for `--research`) is determined by the configuration in `.taskmaster/config.json` based on the requested `role` (`main` or `research`).
- API keys are automatically resolved from your `.env` file (for CLI) or MCP session environment. - API keys are automatically resolved from your `.env` file (for CLI) or MCP session environment.
- To use the research capabilities (e.g., `expand --research`), ensure you have: - To use the research capabilities (e.g., `expand --research`), ensure you have:
1. Configured a model for the `research` role using `task-master models --setup` (Perplexity models are recommended). 1. Configured a model for the `research` role using `task-master models --setup` (research-capable models like Perplexity are recommended).
2. Added the corresponding API key (e.g., `PERPLEXITY_API_KEY`) to your `.env` file. 2. Added the corresponding API key (e.g., `PERPLEXITY_API_KEY`) to your `.env` file.
## Logging ## Logging
@@ -317,13 +317,13 @@ task-master analyze-complexity --model=claude-3-opus-20240229
# Set a custom complexity threshold (1-10) # Set a custom complexity threshold (1-10)
task-master analyze-complexity --threshold=6 task-master analyze-complexity --threshold=6
# Use Perplexity AI for research-backed complexity analysis # Use your configured research model for research-backed complexity analysis
task-master analyze-complexity --research task-master analyze-complexity --research
``` ```
Notes: Notes:
- The command uses Claude to analyze each task's complexity (or Perplexity with --research flag) - The command uses your main model to analyze each task's complexity (or your configured research model with --research flag)
- Tasks are scored on a scale of 1-10 - Tasks are scored on a scale of 1-10
- Each task receives a recommended number of subtasks based on DEFAULT_SUBTASKS configuration - Each task receives a recommended number of subtasks based on DEFAULT_SUBTASKS configuration
- The default output path is `scripts/task-complexity-report.json` - The default output path is `scripts/task-complexity-report.json`