|
|
|
|
@@ -36,7 +36,7 @@ This document provides a detailed reference for interacting with Taskmaster, cov
|
|
|
|
|
* `addAliases`: `Add shell aliases tm and taskmaster. Default is false.` (CLI: `--aliases`)
|
|
|
|
|
* `yes`: `Skip prompts and use defaults/provided arguments. Default is false.` (CLI: `-y, --yes`)
|
|
|
|
|
* **Usage:** Run this once at the beginning of a new project, typically via an integrated tool like Cursor. Operates on the current working directory of the MCP server.
|
|
|
|
|
* **Important:** Once complete, you *MUST* parse a prd in order to generate tasks. There will be no tasks files until then. The next step after initializing should be to create a PRD using the example PRD in scripts/example_prd.txt.
|
|
|
|
|
* **Important:** Once complete, you *MUST* parse a prd in order to generate tasks. There will be no tasks files until then. The next step after initializing should be to create a PRD using the example PRD in .taskmaster/templates/example_prd.txt.
|
|
|
|
|
|
|
|
|
|
### 2. Parse PRD (`parse_prd`)
|
|
|
|
|
|
|
|
|
|
@@ -50,7 +50,7 @@ This document provides a detailed reference for interacting with Taskmaster, cov
|
|
|
|
|
* `force`: `Use this to allow Taskmaster to overwrite an existing 'tasks.json' without asking for confirmation.` (CLI: `-f, --force`)
|
|
|
|
|
* **Usage:** Useful for bootstrapping a project from an existing requirements document.
|
|
|
|
|
* **Notes:** Task Master will strictly adhere to any specific requirements mentioned in the PRD, such as libraries, database schemas, frameworks, tech stacks, etc., while filling in any gaps where the PRD isn't fully specified. Tasks are designed to provide the most direct implementation path while avoiding over-engineering.
|
|
|
|
|
* **Important:** This MCP tool makes AI calls and can take up to a minute to complete. Please inform users to hang tight while the operation is in progress. If the user does not have a PRD, suggest discussing their idea and then use the example PRD in `scripts/example_prd.txt` as a template for creating the PRD based on their idea, for use with `parse-prd`.
|
|
|
|
|
* **Important:** This MCP tool makes AI calls and can take up to a minute to complete. Please inform users to hang tight while the operation is in progress. If the user does not have a PRD, suggest discussing their idea and then use the example PRD in `.taskmaster/templates/example_prd.txt` as a template for creating the PRD based on their idea, for use with `parse-prd`.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
@@ -77,10 +77,10 @@ This document provides a detailed reference for interacting with Taskmaster, cov
|
|
|
|
|
* `--setup`: `Run interactive setup to configure models, including custom Ollama/OpenRouter IDs.`
|
|
|
|
|
* **Usage (MCP):** Call without set flags to get current config. Use `setMain`, `setResearch`, or `setFallback` with a valid model ID to update the configuration. Use `listAvailableModels: true` to get a list of unassigned models. To set a custom model, provide the model ID and set `ollama: true` or `openrouter: true`.
|
|
|
|
|
* **Usage (CLI):** Run without flags to view current configuration and available models. Use set flags to update specific roles. Use `--setup` for guided configuration, including custom models. To set a custom model via flags, use `--set-<role>=<model_id>` along with either `--ollama` or `--openrouter`.
|
|
|
|
|
* **Notes:** Configuration is stored in `.taskmasterconfig` in the project root. This command/tool modifies that file. Use `listAvailableModels` or `task-master models` to see internally supported models. OpenRouter custom models are validated against their live API. Ollama custom models are not validated live.
|
|
|
|
|
* **Notes:** Configuration is stored in `.taskmaster/config.json` in the project root. This command/tool modifies that file. Use `listAvailableModels` or `task-master models` to see internally supported models. OpenRouter custom models are validated against their live API. Ollama custom models are not validated live.
|
|
|
|
|
* **API note:** API keys for selected AI providers (based on their model) need to exist in the mcp.json file to be accessible in MCP context. The API keys must be present in the local .env file for the CLI to be able to read them.
|
|
|
|
|
* **Model costs:** The costs in supported models are expressed in dollars. An input/output value of 3 is $3.00. A value of 0.8 is $0.80.
|
|
|
|
|
* **Warning:** DO NOT MANUALLY EDIT THE .taskmasterconfig FILE. Use the included commands either in the MCP or CLI format as needed. Always prioritize MCP tools when available and use the CLI as a fallback.
|
|
|
|
|
* **Warning:** DO NOT MANUALLY EDIT THE .taskmaster/config.json FILE. Use the included commands either in the MCP or CLI format as needed. Always prioritize MCP tools when available and use the CLI as a fallback.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
@@ -348,7 +348,7 @@ This document provides a detailed reference for interacting with Taskmaster, cov
|
|
|
|
|
* **CLI Command:** `task-master analyze-complexity [options]`
|
|
|
|
|
* **Description:** `Have Taskmaster analyze your tasks to determine their complexity and suggest which ones need to be broken down further.`
|
|
|
|
|
* **Key Parameters/Options:**
|
|
|
|
|
* `output`: `Where to save the complexity analysis report (default: 'scripts/task-complexity-report.json').` (CLI: `-o, --output <file>`)
|
|
|
|
|
* `output`: `Where to save the complexity analysis report (default: '.taskmaster/reports/task-complexity-report.json').` (CLI: `-o, --output <file>`)
|
|
|
|
|
* `threshold`: `The minimum complexity score (1-10) that should trigger a recommendation to expand a task.` (CLI: `-t, --threshold <number>`)
|
|
|
|
|
* `research`: `Enable research role for more accurate complexity analysis. Requires appropriate API key.` (CLI: `-r, --research`)
|
|
|
|
|
* `file`: `Path to your Taskmaster 'tasks.json' file. Default relies on auto-detection.` (CLI: `-f, --file <file>`)
|
|
|
|
|
@@ -361,7 +361,7 @@ This document provides a detailed reference for interacting with Taskmaster, cov
|
|
|
|
|
* **CLI Command:** `task-master complexity-report [options]`
|
|
|
|
|
* **Description:** `Display the task complexity analysis report in a readable format.`
|
|
|
|
|
* **Key Parameters/Options:**
|
|
|
|
|
* `file`: `Path to the complexity report (default: 'scripts/task-complexity-report.json').` (CLI: `-f, --file <file>`)
|
|
|
|
|
* `file`: `Path to the complexity report (default: '.taskmaster/reports/task-complexity-report.json').` (CLI: `-f, --file <file>`)
|
|
|
|
|
* **Usage:** Review and understand the complexity analysis results after running analyze-complexity.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
@@ -382,7 +382,7 @@ This document provides a detailed reference for interacting with Taskmaster, cov
|
|
|
|
|
|
|
|
|
|
## Environment Variables Configuration (Updated)
|
|
|
|
|
|
|
|
|
|
Taskmaster primarily uses the **`.taskmasterconfig`** file (in project root) for configuration (models, parameters, logging level, etc.), managed via `task-master models --setup`.
|
|
|
|
|
Taskmaster primarily uses the **`.taskmaster/config.json`** file (in project root) for configuration (models, parameters, logging level, etc.), managed via `task-master models --setup`.
|
|
|
|
|
|
|
|
|
|
Environment variables are used **only** for sensitive API keys related to AI providers and specific overrides like the Ollama base URL:
|
|
|
|
|
|
|
|
|
|
@@ -396,11 +396,11 @@ Environment variables are used **only** for sensitive API keys related to AI pro
|
|
|
|
|
* `OPENROUTER_API_KEY`
|
|
|
|
|
* `XAI_API_KEY`
|
|
|
|
|
* `OLLANA_API_KEY` (Requires `OLLAMA_BASE_URL` too)
|
|
|
|
|
* **Endpoints (Optional/Provider Specific inside .taskmasterconfig):**
|
|
|
|
|
* **Endpoints (Optional/Provider Specific inside .taskmaster/config.json):**
|
|
|
|
|
* `AZURE_OPENAI_ENDPOINT`
|
|
|
|
|
* `OLLAMA_BASE_URL` (Default: `http://localhost:11434/api`)
|
|
|
|
|
|
|
|
|
|
**Set API keys** in your **`.env`** file in the project root (for CLI use) or within the `env` section of your **`.cursor/mcp.json`** file (for MCP/Cursor integration). All other settings (model choice, max tokens, temperature, log level, custom endpoints) are managed in `.taskmasterconfig` via `task-master models` command or `models` MCP tool.
|
|
|
|
|
**Set API keys** in your **`.env`** file in the project root (for CLI use) or within the `env` section of your **`.cursor/mcp.json`** file (for MCP/Cursor integration). All other settings (model choice, max tokens, temperature, log level, custom endpoints) are managed in `.taskmaster/config.json` via `task-master models` command or `models` MCP tool.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|