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
20 changed files with 236 additions and 67 deletions
--- a/.changeset/README.md
+++ b/.changeset/README.md
@@ -58,9 +58,9 @@ Examples:
 ```md
 # Good

-Added new `--research` flag to the `expand` command that uses Perplexity AI
-to provide research-backed task expansions. Requires PERPLEXITY_API_KEY
-environment variable.
+Added new `--research` flag to the `expand` command that uses your configured research model
+to provide research-backed task expansions. Requires appropriate API key
+for your research model.

 # Not Good

--- a/.claude/commands/tm/analyze-complexity/analyze-complexity.md
+++ b/.claude/commands/tm/analyze-complexity/analyze-complexity.md
@@ -16,7 +16,7 @@ task-master analyze-complexity [--research] [--threshold=5]

 ## 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
 - Default: Analyze all pending tasks

--- a/.cursor/rules/dev_workflow.mdc
+++ b/.cursor/rules/dev_workflow.mdc
@@ -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 `--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).
 -   Use `--prompt="<context>"` to provide additional context when needed.
 -   Review and adjust generated subtasks as necessary.
--- a/.kiro/steering/dev_workflow.md
+++ b/.kiro/steering/dev_workflow.md
@@ -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 `--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).
 -   Use `--prompt="<context>"` to provide additional context when needed.
 -   Review and adjust generated subtasks as necessary.
--- a/.taskmaster/docs/README.md
+++ b/.taskmaster/docs/README.md
@@ -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.
 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.
-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.
 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")
 - `MAX_TOKENS`: Maximum tokens for model responses (default: 4000)
 - `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")
 - `DEBUG`: Enable debug logging (default: false)
 - `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)
 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

 # Specify a different tasks file
@@ -109,7 +109,7 @@ Notes:
 - The `--prompt` parameter is required and should explain the changes or new context
 - Only tasks that aren't marked as 'done' 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

@@ -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
 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
 ```

@@ -178,10 +178,10 @@ node scripts/dev.js expand --all
 # Force regeneration of subtasks for all pending tasks
 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

-# 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
 ```

@@ -211,17 +211,16 @@ Notes:

 The script integrates with two AI services:

-1. **Anthropic Claude**: Used for parsing PRDs, generating tasks, and creating subtasks.
-2. **Perplexity AI**: Used for research-backed subtask generation when the `--research` flag is specified.
+1. **Main AI Model**: Used for parsing PRDs, generating tasks, and creating subtasks (typically Anthropic Claude).
+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
-2. Add `PERPLEXITY_API_KEY` to your `.env` file
-3. Optionally specify `PERPLEXITY_MODEL` in your `.env` file (default: "sonar-medium-online")
-4. Use the `--research` flag with the `expand` command
+1. Configure your research model using `task-master models --setup`
+2. Ensure you have the appropriate API key in your `.env` file (e.g., `PERPLEXITY_API_KEY` if using Perplexity)
+3. Use the `--research` flag with supported commands

 ## Logging

@@ -342,13 +341,13 @@ node scripts/dev.js analyze-complexity --model=claude-3-opus-20240229
 # Set a custom complexity threshold (1-10)
 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
 ```

 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
 - Each task receives a recommended number of subtasks based on DEFAULT_SUBTASKS configuration
 - The default output path is `scripts/task-complexity-report.json`
--- a/README-task-master.md
+++ b/README-task-master.md
@@ -301,7 +301,7 @@ The agent will execute:
 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.
@@ -450,7 +450,7 @@ 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
+# Use your configured research model for research-backed complexity analysis
 task-master analyze-complexity --research
 ```

--- a/apps/docs/README.md
+++ b/apps/docs/README.md
@@ -1,24 +1,22 @@
 # Task Master Documentation

-Welcome to the Task Master documentation. This documentation site provides comprehensive guides for getting started with Task Master.
+Welcome to the Task Master documentation. Use the links below to navigate to the information you need:

 ## Getting Started

- [Quick Start Guide](/getting-started/quick-start) - Complete setup and first-time usage guide
- [Requirements](/getting-started/quick-start/requirements) - What you need to get started
- [Installation](/getting-started/quick-start/installation) - How to install Task Master
+- [Configuration Guide](archive/configuration.md) - Set up environment variables and customize Task Master
+- [Tutorial](archive/ctutorial.md) - Step-by-step guide to getting started with Task Master

-## Core Capabilities
+## Reference

- [MCP Tools](/capabilities/mcp) - Model Control Protocol integration
- [CLI Commands](/capabilities/cli-root-commands) - Command line interface reference
- [Task Structure](/capabilities/task-structure) - Understanding tasks and subtasks
+- [Command Reference](archive/ccommand-reference.md) - Complete list of all available commands
+- [Task Structure](archive/ctask-structure.md) - Understanding the task format and features

-## Best Practices
+## Examples & Licensing

- [Advanced Configuration](/best-practices/configuration-advanced) - Detailed configuration options
- [Advanced Tasks](/best-practices/advanced-tasks) - Working with complex task structures
+- [Example Interactions](archive/cexamples.md) - Common Cursor AI interaction examples
+- [Licensing Information](archive/clicensing.md) - Detailed information about the license

 ## Need More Help?

-If you can't find what you're looking for in these docs, please check the root README.md or visit our [GitHub repository](https://github.com/eyaltoledano/claude-task-master).
+If you can't find what you're looking for in these docs, please check the [main README](../README.md) or visit our [GitHub repository](https://github.com/eyaltoledano/claude-task-master).
--- a/apps/docs/archive/ai-development-workflow.mdx
+++ b/apps/docs/archive/ai-development-workflow.mdx
@@ -118,7 +118,7 @@ description: "Learn how Task Master and Cursor AI work together to streamline yo
    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.
--- a/apps/docs/archive/command-reference.mdx
+++ b/apps/docs/archive/command-reference.mdx
@@ -61,7 +61,7 @@ description: "A comprehensive reference of all available Task Master commands"
    # Update a single task by ID with new information
    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
    ```
  </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
    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
    ```

@@ -155,7 +155,7 @@ description: "A comprehensive reference of all available Task Master commands"
    # Use an alternative tasks file
    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
    ```
  </Accordion>
--- a/apps/docs/getting-started/quick-start/configuration-quick.mdx
+++ b/apps/docs/getting-started/quick-start/configuration-quick.mdx
@@ -108,5 +108,5 @@ You don’t need to configure everything up front. Most settings can be left as
 </Accordion>

 <Note>
-For advanced configuration options and detailed customization, see our [Advanced Configuration Guide](/best-practices/configuration-advanced) page.
+For advanced configuration options and detailed customization, see our [Advanced Configuration Guide](/docs/best-practices/configuration-advanced) page.
 </Note>
--- a/apps/docs/getting-started/quick-start/execute-quick.mdx
+++ b/apps/docs/getting-started/quick-start/execute-quick.mdx
@@ -56,4 +56,4 @@ If you ran into problems and had to debug errors you can create new rules as you

 By now you have all you need to get started executing code faster and smarter with Task Master.

-If you have any questions please check out [Frequently Asked Questions](/getting-started/faq)
+If you have any questions please check out [Frequently Asked Questions](/docs/getting-started/faq)
--- a/apps/docs/getting-started/quick-start/quick-start.mdx
+++ b/apps/docs/getting-started/quick-start/quick-start.mdx
@@ -6,13 +6,13 @@ sidebarTitle: "Quick Start"
 This guide is for new users who want to start using Task Master with minimal setup time.

 It covers:
- [Requirements](/getting-started/quick-start/requirements): You will need Node.js and an AI model API Key.
- [Installation](/getting-started/quick-start/installation): How to Install Task Master.
- [Configuration](/getting-started/quick-start/configuration-quick): Setting up your API Key, MCP, and more.
- [PRD](/getting-started/quick-start/prd-quick): Writing and parsing your first PRD.
- [Task Setup](/getting-started/quick-start/tasks-quick): Preparing your tasks for execution.
- [Executing Tasks](/getting-started/quick-start/execute-quick): Using Task Master to execute tasks.
- [Rules & Context](/getting-started/quick-start/rules-quick): Learn how and why to build context in your project over time.
+- [Requirements](/docs/getting-started/quick-start/requirements): You will need Node.js and an AI model API Key.
+- [Installation](/docs/getting-started/quick-start/installation): How to Install Task Master.
+- [Configuration](/docs/getting-started/quick-start/configuration-quick): Setting up your API Key, MCP, and more.
+- [PRD](/docs/getting-started/quick-start/prd-quick): Writing and parsing your first PRD.
+- [Task Setup](/docs/getting-started/quick-start/tasks-quick): Preparing your tasks for execution.
+- [Executing Tasks](/docs/getting-started/quick-start/execute-quick): Using Task Master to execute tasks.
+- [Rules & Context](/docs/getting-started/quick-start/rules-quick): Learn how and why to build context in your project over time.

 <Tip>
 By the end of this guide, you'll have everything you need to begin working productively with Task Master.
--- a/apps/docs/getting-started/quick-start/tasks-quick.mdx
+++ b/apps/docs/getting-started/quick-start/tasks-quick.mdx
@@ -80,6 +80,6 @@ You can view the report in a friendly table using:
 Can you show me the complexity report in a more readable format?
 ```

-For more detailed CLI options, see the [Analyze Task Complexity](/capabilities/cli-root-commands#analyze-task-complexity) section.
+For more detailed CLI options, see the [Analyze Task Complexity](/docs/capabilities/cli-root-commands#analyze-task-complexity) section.

-<Check>Now you are ready to begin [executing tasks](/getting-started/quick-start/execute-quick)</Check>
+<Check>Now you are ready to begin [executing tasks](/docs/getting-started/quick-start/execute-quick)</Check>
--- a/apps/docs/introduction.mdx
+++ b/apps/docs/introduction.mdx
@@ -4,7 +4,7 @@ Welcome to v1 of the Task Master Docs. Expect weekly updates as we expand and re

 We've organized the docs into three sections depending on your experience level and goals:

-### Getting Started - Jump in to [Quick Start](/getting-started/quick-start)
+### Getting Started - Jump in to [Quick Start](/docs/getting-started/quick-start)
 Designed for first-time users. Get set up, create your first PRD, and run your first task.

 ### Best Practices
--- a/docs/command-reference.md
+++ b/docs/command-reference.md
@@ -181,7 +181,7 @@ 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
+# Use your configured research model for research-backed complexity analysis
 task-master analyze-complexity --research
 ```

--- a/output.txt
+++ b/output.txt
--- a/public/assets/.windsurfrules
+++ b/public/assets/.windsurfrules
@@ -60,7 +60,7 @@ alwaysApply: true

  - For tasks with complexity analysis, use `node scripts/dev.js expand --id=<id>`
  - 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
  - Review and adjust generated subtasks as necessary
  - 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)
    - `--all`: Expand all pending tasks, prioritized by complexity
    - `--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
    - `--force`: Regenerate subtasks even for tasks that already have them
  - 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
    - `--threshold=<number>, -t`: Minimum score for expansion recommendation (default: 5)
    - `--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`
  - Notes: Report includes complexity scores, recommended subtasks, and tailored prompts.

--- a/public/assets/claude/commands/tm/analyze-complexity/analyze-complexity.md
+++ b/public/assets/claude/commands/tm/analyze-complexity/analyze-complexity.md
@@ -16,7 +16,7 @@ task-master analyze-complexity [--research] [--threshold=5]

 ## 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
 - Default: Analyze all pending tasks

--- a/public/assets/rules/dev_workflow.mdc
+++ b/public/assets/rules/dev_workflow.mdc
@@ -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 `--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).
 -   Use `--prompt="<context>"` to provide additional context when needed.
 -   Review and adjust generated subtasks as necessary.
--- a/public/assets/scripts_README.md
+++ b/public/assets/scripts_README.md
@@ -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.
 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.
-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.
 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.

 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.
    - See `assets/env.example` for required key names.

@@ -160,10 +160,10 @@ task-master expand --all
 # Force regeneration of subtasks for all pending tasks
 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

-# 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
 ```

@@ -192,10 +192,10 @@ Notes:
 ## AI Integration (Updated)

 - 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.
 - 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.

 ## Logging
@@ -317,13 +317,13 @@ task-master analyze-complexity --model=claude-3-opus-20240229
 # Set a custom complexity threshold (1-10)
 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
 ```

 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
 - Each task receives a recommended number of subtasks based on DEFAULT_SUBTASKS configuration
 - The default output path is `scripts/task-complexity-report.json`