chore: formatting

This commit is contained in:
Eyal Toledano
2025-05-23 14:44:53 -04:00
parent a59dd037cf
commit 43ad75c7fa
2 changed files with 115 additions and 78 deletions

View File

@@ -3,6 +3,7 @@
## Essential Commands ## Essential Commands
### Core Workflow Commands ### Core Workflow Commands
```bash ```bash
# Project Setup # Project Setup
task-master init # Initialize Task Master in current project task-master init # Initialize Task Master in current project
@@ -37,6 +38,7 @@ task-master generate # Update task markd
## Key Files & Project Structure ## Key Files & Project Structure
### Core Files ### Core Files
- `tasks/tasks.json` - Main task data file (auto-managed) - `tasks/tasks.json` - Main task data file (auto-managed)
- `.taskmasterconfig` - AI model configuration (use `task-master models` to modify) - `.taskmasterconfig` - AI model configuration (use `task-master models` to modify)
- `scripts/prd.txt` - Product Requirements Document for parsing - `scripts/prd.txt` - Product Requirements Document for parsing
@@ -44,12 +46,14 @@ task-master generate # Update task markd
- `.env` - API keys for CLI usage - `.env` - API keys for CLI usage
### Claude Code Integration Files ### Claude Code Integration Files
- `CLAUDE.md` - Auto-loaded context for Claude Code (this file) - `CLAUDE.md` - Auto-loaded context for Claude Code (this file)
- `.claude/settings.json` - Claude Code tool allowlist and preferences - `.claude/settings.json` - Claude Code tool allowlist and preferences
- `.claude/commands/` - Custom slash commands for repeated workflows - `.claude/commands/` - Custom slash commands for repeated workflows
- `.mcp.json` - MCP server configuration (project-specific) - `.mcp.json` - MCP server configuration (project-specific)
### Directory Structure ### Directory Structure
``` ```
project/ project/
├── tasks/ ├── tasks/
@@ -95,28 +99,29 @@ Task Master provides an MCP server that Claude Code can connect to. Configure in
``` ```
### Essential MCP Tools ### Essential MCP Tools
```javascript ```javascript
help // = shows available taskmaster commands help; // = shows available taskmaster commands
// Project setup // Project setup
initialize_project // = task-master init initialize_project; // = task-master init
parse_prd // = task-master parse-prd parse_prd; // = task-master parse-prd
// Daily workflow // Daily workflow
get_tasks // = task-master list get_tasks; // = task-master list
next_task // = task-master next next_task; // = task-master next
get_task // = task-master show <id> get_task; // = task-master show <id>
set_task_status // = task-master set-status set_task_status; // = task-master set-status
// Task management // Task management
add_task // = task-master add-task add_task; // = task-master add-task
expand_task // = task-master expand expand_task; // = task-master expand
update_task // = task-master update-task update_task; // = task-master update-task
update_subtask // = task-master update-subtask update_subtask; // = task-master update-subtask
update // = task-master update update; // = task-master update
// Analysis // Analysis
analyze_project_complexity // = task-master analyze-complexity analyze_project_complexity; // = task-master analyze-complexity
complexity_report // = task-master complexity-report complexity_report; // = task-master complexity-report
``` ```
## Claude Code Workflow Integration ## Claude Code Workflow Integration
@@ -124,6 +129,7 @@ complexity_report // = task-master complexity-report
### Standard Development Workflow ### Standard Development Workflow
#### 1. Project Initialization #### 1. Project Initialization
```bash ```bash
# Initialize Task Master # Initialize Task Master
task-master init task-master init
@@ -139,6 +145,7 @@ task-master expand --all --research
If tasks already exist, another PRD can be parsed (with new information only!) using parse-prd with --append flag. This will add the generated tasks to the existing list of tasks.. If tasks already exist, another PRD can be parsed (with new information only!) using parse-prd with --append flag. This will add the generated tasks to the existing list of tasks..
#### 2. Daily Development Loop #### 2. Daily Development Loop
```bash ```bash
# Start each session # Start each session
task-master next # Find next available task task-master next # Find next available task
@@ -152,6 +159,7 @@ task-master set-status --id=<id> --status=done
``` ```
#### 3. Multi-Claude Workflows #### 3. Multi-Claude Workflows
For complex projects, use multiple Claude Code sessions: For complex projects, use multiple Claude Code sessions:
```bash ```bash
@@ -168,10 +176,12 @@ cd project-docs-worktree && claude
### Custom Slash Commands ### Custom Slash Commands
Create `.claude/commands/taskmaster-next.md`: Create `.claude/commands/taskmaster-next.md`:
```markdown ```markdown
Find the next available Task Master task and show its details. Find the next available Task Master task and show its details.
Steps: Steps:
1. Run `task-master next` to get the next task 1. Run `task-master next` to get the next task
2. If a task is available, run `task-master show <id>` for full details 2. If a task is available, run `task-master show <id>` for full details
3. Provide a summary of what needs to be implemented 3. Provide a summary of what needs to be implemented
@@ -179,10 +189,12 @@ Steps:
``` ```
Create `.claude/commands/taskmaster-complete.md`: Create `.claude/commands/taskmaster-complete.md`:
```markdown ```markdown
Complete a Task Master task: $ARGUMENTS Complete a Task Master task: $ARGUMENTS
Steps: Steps:
1. Review the current task with `task-master show $ARGUMENTS` 1. Review the current task with `task-master show $ARGUMENTS`
2. Verify all implementation is complete 2. Verify all implementation is complete
3. Run any tests related to this task 3. Run any tests related to this task
@@ -193,6 +205,7 @@ Steps:
## Tool Allowlist Recommendations ## Tool Allowlist Recommendations
Add to `.claude/settings.json`: Add to `.claude/settings.json`:
```json ```json
{ {
"allowedTools": [ "allowedTools": [
@@ -209,7 +222,9 @@ Add to `.claude/settings.json`:
## Configuration & Setup ## Configuration & Setup
### API Keys Required ### API Keys Required
At least **one** of these API keys must be configured: At least **one** of these API keys must be configured:
- `ANTHROPIC_API_KEY` (Claude models) - **Recommended** - `ANTHROPIC_API_KEY` (Claude models) - **Recommended**
- `PERPLEXITY_API_KEY` (Research features) - **Highly recommended** - `PERPLEXITY_API_KEY` (Research features) - **Highly recommended**
- `OPENAI_API_KEY` (GPT models) - `OPENAI_API_KEY` (GPT models)
@@ -221,6 +236,7 @@ At least **one** of these API keys must be configured:
An API key is required for any provider used across any of the 3 roles defined in the `models` command. An API key is required for any provider used across any of the 3 roles defined in the `models` command.
### Model Configuration ### Model Configuration
```bash ```bash
# Interactive setup (recommended) # Interactive setup (recommended)
task-master models --setup task-master models --setup
@@ -234,11 +250,13 @@ task-master models --set-fallback gpt-4o-mini
## Task Structure & IDs ## Task Structure & IDs
### Task ID Format ### Task ID Format
- Main tasks: `1`, `2`, `3`, etc. - Main tasks: `1`, `2`, `3`, etc.
- Subtasks: `1.1`, `1.2`, `2.1`, etc. - Subtasks: `1.1`, `1.2`, `2.1`, etc.
- Sub-subtasks: `1.1.1`, `1.1.2`, etc. - Sub-subtasks: `1.1.1`, `1.1.2`, etc.
### Task Status Values ### Task Status Values
- `pending` - Ready to work on - `pending` - Ready to work on
- `in-progress` - Currently being worked on - `in-progress` - Currently being worked on
- `done` - Completed and verified - `done` - Completed and verified
@@ -247,6 +265,7 @@ task-master models --set-fallback gpt-4o-mini
- `blocked` - Waiting on external factors - `blocked` - Waiting on external factors
### Task Fields ### Task Fields
```json ```json
{ {
"id": "1.2", "id": "1.2",
@@ -264,11 +283,13 @@ task-master models --set-fallback gpt-4o-mini
## Claude Code Best Practices with Task Master ## Claude Code Best Practices with Task Master
### Context Management ### Context Management
- Use `/clear` between different tasks to maintain focus - Use `/clear` between different tasks to maintain focus
- This CLAUDE.md file is automatically loaded for context - This CLAUDE.md file is automatically loaded for context
- Use `task-master show <id>` to pull specific task context when needed - Use `task-master show <id>` to pull specific task context when needed
### Iterative Implementation ### Iterative Implementation
1. `task-master show <subtask-id>` - Understand requirements 1. `task-master show <subtask-id>` - Understand requirements
2. Explore codebase and plan implementation 2. Explore codebase and plan implementation
3. `task-master update-subtask --id=<id> --prompt="detailed plan"` - Log plan 3. `task-master update-subtask --id=<id> --prompt="detailed plan"` - Log plan
@@ -278,6 +299,7 @@ task-master models --set-fallback gpt-4o-mini
7. `task-master set-status --id=<id> --status=done` - Complete task 7. `task-master set-status --id=<id> --status=done` - Complete task
### Complex Workflows with Checklists ### Complex Workflows with Checklists
For large migrations or multi-step processes: For large migrations or multi-step processes:
1. Create a markdown PRD file describing the new changes: `touch task-migration-checklist.md` (prds can be .txt or .md) 1. Create a markdown PRD file describing the new changes: `touch task-migration-checklist.md` (prds can be .txt or .md)
@@ -287,7 +309,9 @@ For large migrations or multi-step processes:
5. Use `task-master update-subtask` to log progress on each task/subtask and/or updating/researching them before/during implementation if getting stuck 5. Use `task-master update-subtask` to log progress on each task/subtask and/or updating/researching them before/during implementation if getting stuck
### Git Integration ### Git Integration
Task Master works well with `gh` CLI: Task Master works well with `gh` CLI:
```bash ```bash
# Create PR for completed task # Create PR for completed task
gh pr create --title "Complete task 1.2: User authentication" --body "Implements JWT auth system as specified in task 1.2" gh pr create --title "Complete task 1.2: User authentication" --body "Implements JWT auth system as specified in task 1.2"
@@ -297,6 +321,7 @@ git commit -m "feat: implement JWT auth (task 1.2)"
``` ```
### Parallel Development with Git Worktrees ### Parallel Development with Git Worktrees
```bash ```bash
# Create worktrees for parallel task development # Create worktrees for parallel task development
git worktree add ../project-auth feature/auth-system git worktree add ../project-auth feature/auth-system
@@ -310,6 +335,7 @@ cd ../project-api && claude # Terminal 2: API work
## Troubleshooting ## Troubleshooting
### AI Commands Failing ### AI Commands Failing
```bash ```bash
# Check API keys are configured # Check API keys are configured
cat .env # For CLI usage cat .env # For CLI usage
@@ -322,12 +348,14 @@ task-master models --set-fallback gpt-4o-mini
``` ```
### MCP Connection Issues ### MCP Connection Issues
- Check `.mcp.json` configuration - Check `.mcp.json` configuration
- Verify Node.js installation - Verify Node.js installation
- Use `--mcp-debug` flag when starting Claude Code - Use `--mcp-debug` flag when starting Claude Code
- Use CLI as fallback if MCP unavailable - Use CLI as fallback if MCP unavailable
### Task File Sync Issues ### Task File Sync Issues
```bash ```bash
# Regenerate task files from tasks.json # Regenerate task files from tasks.json
task-master generate task-master generate
@@ -341,7 +369,9 @@ DO NOT RE-INITIALIZE. That will not do anything beyond re-adding the same Taskma
## Important Notes ## Important Notes
### AI-Powered Operations ### AI-Powered Operations
These commands make AI calls and may take up to a minute: These commands make AI calls and may take up to a minute:
- `parse_prd` / `task-master parse-prd` - `parse_prd` / `task-master parse-prd`
- `analyze_project_complexity` / `task-master analyze-complexity` - `analyze_project_complexity` / `task-master analyze-complexity`
- `expand_task` / `task-master expand` - `expand_task` / `task-master expand`
@@ -352,23 +382,27 @@ These commands make AI calls and may take up to a minute:
- `update_subtask` / `task-master update-subtask` - `update_subtask` / `task-master update-subtask`
### File Management ### File Management
- Never manually edit `tasks.json` - use commands instead - Never manually edit `tasks.json` - use commands instead
- Never manually edit `.taskmasterconfig` - use `task-master models` - Never manually edit `.taskmasterconfig` - use `task-master models`
- Task markdown files in `tasks/` are auto-generated - Task markdown files in `tasks/` are auto-generated
- Run `task-master generate` after manual changes to tasks.json - Run `task-master generate` after manual changes to tasks.json
### Claude Code Session Management ### Claude Code Session Management
- Use `/clear` frequently to maintain focused context - Use `/clear` frequently to maintain focused context
- Create custom slash commands for repeated Task Master workflows - Create custom slash commands for repeated Task Master workflows
- Configure tool allowlist to streamline permissions - Configure tool allowlist to streamline permissions
- Use headless mode for automation: `claude -p "task-master next"` - Use headless mode for automation: `claude -p "task-master next"`
### Multi-Task Updates ### Multi-Task Updates
- Use `update --from=<id>` to update multiple future tasks - Use `update --from=<id>` to update multiple future tasks
- Use `update-task --id=<id>` for single task updates - Use `update-task --id=<id>` for single task updates
- Use `update-subtask --id=<id>` for implementation logging - Use `update-subtask --id=<id>` for implementation logging
### Research Mode ### Research Mode
- Add `--research` flag for research-based AI enhancement - Add `--research` flag for research-based AI enhancement
- Requires a research model API key like Perplexity (`PERPLEXITY_API_KEY`) in environment - Requires a research model API key like Perplexity (`PERPLEXITY_API_KEY`) in environment
- Provides more informed task creation and updates - Provides more informed task creation and updates
@@ -376,4 +410,4 @@ These commands make AI calls and may take up to a minute:
--- ---
*This guide ensures Claude Code has immediate access to Task Master's essential functionality for agentic development workflows.* _This guide ensures Claude Code has immediate access to Task Master's essential functionality for agentic development workflows._

View File

@@ -35,6 +35,7 @@ Add the following configuration to the user's MCP settings file (`.cursor/mcp.js
### Step 2: API Key Requirements ### Step 2: API Key Requirements
Inform the user they need **at least one** API key from the following providers: Inform the user they need **at least one** API key from the following providers:
- **Anthropic** (for Claude models) - Recommended - **Anthropic** (for Claude models) - Recommended
- **OpenAI** (for GPT models) - **OpenAI** (for GPT models)
- **Google** (for Gemini models) - **Google** (for Gemini models)
@@ -88,7 +89,6 @@ If the user does not have a PRD, the AI agent can help them create one and store
> Can you move task [ID] to become a subtask of [parent ID]? > Can you move task [ID] to become a subtask of [parent ID]?
> Can you update task [ID] with this new information: [details] > Can you update task [ID] with this new information: [details]
## Verification Steps ## Verification Steps
After installation, verify everything is working: After installation, verify everything is working:
@@ -104,11 +104,13 @@ When adding keys to `.env` only, the `models` tool will explain that the keys ar
## Troubleshooting ## Troubleshooting
**If MCP server doesn't start:** **If MCP server doesn't start:**
- Verify the JSON configuration is valid - Verify the JSON configuration is valid
- Check that Node.js is installed - Check that Node.js is installed
- Ensure API keys are properly formatted - Ensure API keys are properly formatted
**If AI commands fail:** **If AI commands fail:**
- Verify at least one API key is configured - Verify at least one API key is configured
- Check API key permissions and quotas - Check API key permissions and quotas
- Try using a different model via the `models` tool - Try using a different model via the `models` tool
@@ -120,6 +122,7 @@ Taskmaster is also available via CLI commands, by installing with `npm install t
## Next Steps ## Next Steps
Once installed, users can: Once installed, users can:
- Create new tasks with `add-task` or parse a PRD (scripts/prd.txt) into tasks with `parse-prd` - Create new tasks with `add-task` or parse a PRD (scripts/prd.txt) into tasks with `parse-prd`
- Set up model preferences with `models` tool - Set up model preferences with `models` tool
- Expand tasks into subtasks with `expand-all` and `expand-task` - Expand tasks into subtasks with `expand-all` and `expand-task`