diff --git a/.changeset/chore-fix-docs.md b/.changeset/chore-fix-docs.md new file mode 100644 index 00000000..9b73e3a5 --- /dev/null +++ b/.changeset/chore-fix-docs.md @@ -0,0 +1,5 @@ +--- +"task-master-ai": patch +--- + +Improve `analyze-complexity` cli docs and `--research` flag documentation \ No newline at end of file diff --git a/apps/docs/capabilities/cli-root-commands.mdx b/apps/docs/capabilities/cli-root-commands.mdx index bfe2591b..3a7cbf49 100644 --- a/apps/docs/capabilities/cli-root-commands.mdx +++ b/apps/docs/capabilities/cli-root-commands.mdx @@ -156,7 +156,7 @@ sidebarTitle: "CLI Commands" # 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 ``` diff --git a/apps/docs/getting-started/quick-start/tasks-quick.mdx b/apps/docs/getting-started/quick-start/tasks-quick.mdx index 85ce8f1b..598b1c20 100644 --- a/apps/docs/getting-started/quick-start/tasks-quick.mdx +++ b/apps/docs/getting-started/quick-start/tasks-quick.mdx @@ -61,9 +61,25 @@ Task Master can provide a complexity report which can be helpful to read before Can you analyze the complexity of our tasks to help me understand which ones need to be broken down further? ``` +The agent will use the `analyze_project_complexity` MCP tool, or you can run it directly with the CLI command: +```bash +task-master analyze-complexity +``` + +For more comprehensive analysis using your configured research model, you can use: +```bash +task-master analyze-complexity --research +``` + + +The `--research` flag uses whatever research model you have configured in `.taskmaster/config.json` (configurable via `task-master models --setup`) for research-backed complexity analysis, providing more informed recommendations. + + 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](/docs/capabilities/cli-root-commands#analyze-task-complexity) section. + Now you are ready to begin [executing tasks](/docs/getting-started/quick-start/execute-quick) \ No newline at end of file diff --git a/scripts/modules/commands.js b/scripts/modules/commands.js index bb515526..022e4176 100644 --- a/scripts/modules/commands.js +++ b/scripts/modules/commands.js @@ -1847,7 +1847,7 @@ function registerCommands(programInstance) { ) .option( '-r, --research', - 'Use Perplexity AI for research-backed complexity analysis' + 'Use configured research model for research-backed complexity analysis' ) .option( '-i, --id ',