d2f761c652
- Enhance E2E testing and LLM analysis report and: - Add --analyze-log flag to run_e2e.sh to re-run LLM analysis on existing logs. - Add test:e2e and analyze-log scripts to package.json for easier execution. - Correct display errors and dependency validation output: - Update chalk usage in add-task.js to use bracket notation (chalk[color]) compatible with v5, resolving 'chalk.keyword is not a function' error. - Modify fix-dependencies command output to show red failure box with issue count instead of green success box when validation fails. - Refactor interactive model setup: - Verify inclusion of 'No change' option during interactive model setup flow (task-master models --setup). - Update model definitions: - Add max_tokens field for gpt-4o in supported-models.json. - Remove unused scripts: - Delete prepare-package.js and rule-transformer.test.js. Release candidate
162 lines
4.9 KiB
Markdown
162 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) [](https://discord.gg/taskmasterai) [](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. **Add the MCP config to your editor** (Cursor recommended, but it works with other text editors):
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"taskmaster-ai": {
|
|
"command": "npx",
|
|
"args": ["-y", "--package=task-master-ai", "task-master-ai"],
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
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.
|