9b5c625bd0
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.
169 lines
4.9 KiB
Markdown
169 lines
4.9 KiB
Markdown
# Task Master [](https://github.com/eyaltoledano/claude-task-master/stargazers)
|
|
|
|
[](https://github.com/eyaltoledano/claude-task-master/actions/workflows/ci.yml) [](https://badge.fury.io/js/task-master-ai)  [](LICENSE)
|
|
|
|
### By [@eyaltoledano](https://x.com/eyaltoledano) & [@RalphEcom](https://x.com/RalphEcom)
|
|
|
|
[](https://x.com/eyaltoledano)
|
|
[](https://x.com/RalphEcom)
|
|
|
|
A task management system for AI-driven development with Claude, designed to work seamlessly with Cursor AI.
|
|
|
|
## Requirements
|
|
|
|
- Anthropic API key (Claude API)
|
|
- OpenAI SDK (for Perplexity API integration, optional)
|
|
|
|
## Quick Start
|
|
|
|
### Option 1 | MCP (Recommended):
|
|
|
|
MCP (Model Control Protocol) provides the easiest way to get started with Task Master directly in your editor.
|
|
|
|
1. **Install the package**
|
|
|
|
```bash
|
|
npm i -g task-master-ai
|
|
```
|
|
|
|
2. **Add the MCP config to your editor** (Cursor recommended, but it works with other text editors):
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"taskmaster-ai": {
|
|
"command": "npx",
|
|
"args": ["-y", "task-master-mcp"],
|
|
"env": {
|
|
"ANTHROPIC_API_KEY": "YOUR_ANTHROPIC_API_KEY_HERE",
|
|
"PERPLEXITY_API_KEY": "YOUR_PERPLEXITY_API_KEY_HERE",
|
|
"OPENAI_API_KEY": "YOUR_OPENAI_KEY_HERE",
|
|
"GOOGLE_API_KEY": "YOUR_GOOGLE_KEY_HERE",
|
|
"MISTRAL_API_KEY": "YOUR_MISTRAL_KEY_HERE",
|
|
"OPENROUTER_API_KEY": "YOUR_OPENROUTER_KEY_HERE",
|
|
"XAI_API_KEY": "YOUR_XAI_KEY_HERE",
|
|
"AZURE_OPENAI_API_KEY": "YOUR_AZURE_KEY_HERE",
|
|
"OLLAMA_API_KEY": "YOUR_OLLAMA_KEY_HERE"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
2. **Enable the MCP** in your editor
|
|
|
|
3. **Prompt the AI** to initialize Task Master:
|
|
|
|
```
|
|
Can you please initialize taskmaster-ai into my project?
|
|
```
|
|
|
|
4. **Use common commands** directly through your AI assistant:
|
|
|
|
```txt
|
|
Can you parse my PRD at scripts/prd.txt?
|
|
What's the next task I should work on?
|
|
Can you help me implement task 3?
|
|
Can you help me expand task 4?
|
|
```
|
|
|
|
### Option 2: Using Command Line
|
|
|
|
#### Installation
|
|
|
|
```bash
|
|
# Install globally
|
|
npm install -g task-master-ai
|
|
|
|
# OR install locally within your project
|
|
npm install task-master-ai
|
|
```
|
|
|
|
#### Initialize a new project
|
|
|
|
```bash
|
|
# If installed globally
|
|
task-master init
|
|
|
|
# If installed locally
|
|
npx task-master-init
|
|
```
|
|
|
|
This will prompt you for project details and set up a new project with the necessary files and structure.
|
|
|
|
#### Common Commands
|
|
|
|
```bash
|
|
# Initialize a new project
|
|
task-master init
|
|
|
|
# Parse a PRD and generate tasks
|
|
task-master parse-prd your-prd.txt
|
|
|
|
# List all tasks
|
|
task-master list
|
|
|
|
# Show the next task to work on
|
|
task-master next
|
|
|
|
# Generate task files
|
|
task-master generate
|
|
```
|
|
|
|
## Documentation
|
|
|
|
For more detailed information, check out the documentation in the `docs` directory:
|
|
|
|
- [Configuration Guide](docs/configuration.md) - Set up environment variables and customize Task Master
|
|
- [Tutorial](docs/tutorial.md) - Step-by-step guide to getting started with Task Master
|
|
- [Command Reference](docs/command-reference.md) - Complete list of all available commands
|
|
- [Task Structure](docs/task-structure.md) - Understanding the task format and features
|
|
- [Example Interactions](docs/examples.md) - Common Cursor AI interaction examples
|
|
|
|
## Troubleshooting
|
|
|
|
### If `task-master init` doesn't respond:
|
|
|
|
Try running it with Node directly:
|
|
|
|
```bash
|
|
node node_modules/claude-task-master/scripts/init.js
|
|
```
|
|
|
|
Or clone the repository and run:
|
|
|
|
```bash
|
|
git clone https://github.com/eyaltoledano/claude-task-master.git
|
|
cd claude-task-master
|
|
node scripts/init.js
|
|
```
|
|
|
|
## Contributors
|
|
|
|
<a href="https://github.com/eyaltoledano/claude-task-master/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=eyaltoledano/claude-task-master" alt="Task Master project contributors" />
|
|
</a>
|
|
|
|
## Star History
|
|
|
|
[](https://www.star-history.com/#eyaltoledano/claude-task-master&Timeline)
|
|
|
|
## Licensing
|
|
|
|
Task Master is licensed under the MIT License with Commons Clause. This means you can:
|
|
|
|
✅ **Allowed**:
|
|
|
|
- Use Task Master for any purpose (personal, commercial, academic)
|
|
- Modify the code
|
|
- Distribute copies
|
|
- Create and sell products built using Task Master
|
|
|
|
❌ **Not Allowed**:
|
|
|
|
- Sell Task Master itself
|
|
- Offer Task Master as a hosted service
|
|
- Create competing products based on Task Master
|
|
|
|
See the [LICENSE](LICENSE) file for the complete license text and [licensing details](docs/licensing.md) for more information.
|