533420a17e
This PR was automatically generated to update documentation based on recent changes. Original commit: chore: cleanup changelog and pre exit\n\n Co-authored-by: Claude <claude-assistant@anthropic.com>
186 lines
6.8 KiB
Plaintext
186 lines
6.8 KiB
Plaintext
---
|
|
title: Installation
|
|
sidebarTitle: "Installation"
|
|
---
|
|
|
|
Now that you have Node.js and your first API Key, you are ready to begin installing Task Master in one of three ways.
|
|
|
|
<Note>Cursor Users Can Use the One Click Install Below</Note>
|
|
<Accordion title="Quick Install for Cursor 1.0+ (One-Click)">
|
|
|
|
<a href="cursor://anysphere.cursor-deeplink/mcp/install?name=task-master-ai&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIi0tcGFja2FnZT10YXNrLW1hc3Rlci1haSIsInRhc2stbWFzdGVyLWFpIl0sImVudiI6eyJBTlRIUk9QSUNfQVBJX0tFWSI6IllPVVJfQU5USFJPUElDX0FQSV9LRVlfSEVSRSIsIlBFUlBMRVhJVFlfQVBJX0tFWSI6IllPVVJfUEVSUExFWElUWV9BUElfS0VZX0hFUkUiLCJPUEVOQUlfQVBJX0tFWSI6IllPVVJfT1BFTkFJX0tFWV9IRVJFIiwiR09PR0xFX0FQSV9LRVkiOiJZT1VSX0dPT0dMRV9LRVlfSEVSRSIsIk1JU1RSQUxfQVBJX0tFWSI6IllPVVJfTUlTVFJBTF9LRVlfSEVSRSIsIk9QRU5ST1VURVJfQVBJX0tFWSI6IllPVVJfT1BFTlJPVVRFUl9LRVlfSEVSRSIsIlhBSV9BUElfS0VZIjoiWU9VUl9YQUlfS0VZX0hFUkUiLCJBWlVSRV9PUEVOQUJFX0FQSV9LRVkiOiJZT1VSX0FaVVJFX0tFWV9IRVJFIiwiT0xMQU1BX0FQSV9LRVkiOiJZT1VSX09MTEFNQV9BUElfS0VZX0hFUkUifX0%3D">
|
|
<img
|
|
className="block dark:hidden"
|
|
src="https://cursor.com/deeplink/mcp-install-light.png"
|
|
alt="Add Task Master MCP server to Cursor"
|
|
noZoom
|
|
/>
|
|
<img
|
|
className="hidden dark:block"
|
|
src="https://cursor.com/deeplink/mcp-install-dark.png"
|
|
alt="Add Task Master MCP server to Cursor"
|
|
noZoom
|
|
/>
|
|
</a>
|
|
|
|
Or click the copy button (top-right of code block) then paste into your browser:
|
|
|
|
```text
|
|
cursor://anysphere.cursor-deeplink/mcp/install?name=taskmaster-ai&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIi0tcGFja2FnZT10YXNrLW1hc3Rlci1haSIsInRhc2stbWFzdGVyLWFpIl0sImVudiI6eyJBTlRIUk9QSUNfQVBJX0tFWSI6IllPVVJfQU5USFJPUElDX0FQSV9LRVlfSEVSRSIsIlBFUlBMRVhJVFlfQVBJX0tFWSI6IllPVVJfUEVSUExFWElUWV9BUElfS0VZX0hFUkUiLCJPUEVOQUlfQVBJX0tFWSI6IllPVVJfT1BFTkFJX0tFWV9IRVJFIiwiR09PR0xFX0FQSV9LRVkiOiJZT1VSX0dPT0dMRV9LRVlfSEVSRSIsIk1JU1RSQUxfQVBJX0tFWSI6IllPVVJfTUlTVFJBTF9LRVlfSEVSRSIsIk9QRU5ST1VURVJfQVBJX0tFWSI6IllPVVJfT1BFTlJPVVRFUl9LRVlfSEVSRSIsIlhBSV9BUElfS0VZIjoiWU9VUl9YQUlfS0VZX0hFUkUiLCJBWlVSRV9PUEVOQUlfQVBJX0tFWSI6IllPVVJfQVpVUkVfS0VZX0hFUkUiLCJPTExBTUFfQVBJX0tFWSI6IllPVVJfT0xMQU1BX0FQSV9LRVlfSEVSRSJ9fQo=
|
|
```
|
|
|
|
> **Note:** After clicking the link, you'll still need to add your API keys to the configuration. The link installs the MCP server with placeholder keys that you'll need to replace with your actual API keys.
|
|
|
|
### Claude Code Plugin Install (Recommended)
|
|
|
|
For Claude Code users, install via the plugin marketplace:
|
|
|
|
```bash
|
|
/plugin marketplace add eyaltoledano/claude-task-master
|
|
/plugin install taskmaster@taskmaster
|
|
```
|
|
|
|
This provides:
|
|
- **49 slash commands** with clean naming (`/taskmaster:command-name`)
|
|
- **3 specialized AI agents** (task-orchestrator, task-executor, task-checker)
|
|
- **Automatic updates** when new features are released
|
|
|
|
### Claude Code MCP Alternative
|
|
|
|
You can also use MCP directly:
|
|
|
|
```bash
|
|
claude mcp add taskmaster-ai -- npx -y task-master-ai
|
|
```
|
|
|
|
Don't forget to add your API keys to the configuration:
|
|
- in the root .env of your Project
|
|
- in the "env" section of your mcp config for taskmaster-ai
|
|
|
|
</Accordion>
|
|
## Installation Options
|
|
|
|
|
|
<Accordion title="Option 1: MCP (Recommended)">
|
|
|
|
MCP (Model Control Protocol) lets you run Task Master directly from your editor.
|
|
|
|
## 1. Add your MCP config at the following path depending on your editor
|
|
|
|
| Editor | Scope | Linux/macOS Path | Windows Path | Key |
|
|
| ------------ | ------- | ------------------------------------- | ------------------------------------------------- | ------------ |
|
|
| **Cursor** | Global | `~/.cursor/mcp.json` | `%USERPROFILE%\.cursor\mcp.json` | `mcpServers` |
|
|
| | Project | `<project_folder>/.cursor/mcp.json` | `<project_folder>\.cursor\mcp.json` | `mcpServers` |
|
|
| **Windsurf** | Global | `~/.codeium/windsurf/mcp_config.json` | `%USERPROFILE%\.codeium\windsurf\mcp_config.json` | `mcpServers` |
|
|
| **VS Code** | Project | `<project_folder>/.vscode/mcp.json` | `<project_folder>\.vscode\mcp.json` | `servers` |
|
|
|
|
## Manual Configuration
|
|
|
|
### Cursor & Windsurf (`mcpServers`)
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"taskmaster-ai": {
|
|
"command": "npx",
|
|
"args": ["-y", "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",
|
|
"OLLAMA_API_KEY": "YOUR_OLLAMA_API_KEY_HERE"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
> 🔑 Replace `YOUR_…_KEY_HERE` with your real API keys. You can remove keys you don't use.
|
|
|
|
> **Note**: If you see `0 tools enabled` in the MCP settings, restart your editor and check that your API keys are correctly configured.
|
|
|
|
### VS Code (`servers` + `type`)
|
|
|
|
```json
|
|
{
|
|
"servers": {
|
|
"taskmaster-ai": {
|
|
"command": "npx",
|
|
"args": ["-y", "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"
|
|
},
|
|
"type": "stdio"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
> 🔑 Replace `YOUR_…_KEY_HERE` with your real API keys. You can remove keys you don't use.
|
|
|
|
#### 2. (Cursor-only) Enable Taskmaster MCP
|
|
|
|
Open Cursor Settings (Ctrl+Shift+J) ➡ Click on MCP tab on the left ➡ Enable task-master-ai with the toggle
|
|
|
|
#### 3. (Optional) Configure the models you want to use
|
|
|
|
In your editor's AI chat pane, say:
|
|
|
|
```txt
|
|
Change the main, research and fallback models to <model_name>, <model_name> and <model_name> respectively.
|
|
```
|
|
|
|
For example, to use Claude Code (no API key required):
|
|
```txt
|
|
Change the main model to claude-code/sonnet
|
|
```
|
|
|
|
#### 4. Initialize Task Master
|
|
|
|
In your editor's AI chat pane, say:
|
|
|
|
```txt
|
|
Initialize taskmaster-ai in my project
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="Option 2: Using Command Line">
|
|
|
|
## CLI 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
|
|
|
|
# Initialize project with specific rules
|
|
task-master init --rules cursor,windsurf,vscode
|
|
```
|
|
|
|
This will prompt you for project details and set up a new project with the necessary files and structure.
|
|
</Accordion> |