mirror of
https://github.com/eyaltoledano/claude-task-master.git
synced 2026-01-30 06:12:05 +00:00
docs: auto-update documentation based on changes in next branch
This PR was automatically generated to update documentation based on recent changes. Original commit: feat: improve ham connection (#1451)\n\n\n Co-authored-by: Claude <claude-assistant@anthropic.com>
This commit is contained in:
@@ -152,9 +152,9 @@ The MCP tools can be categorized in the same way as the core functionalities:
|
||||
### 2. Task Information and Status
|
||||
|
||||
- **`get_tasks`**: Lists all tasks.
|
||||
- **`get_task`**: Shows the details of a specific task.
|
||||
- **`get_task`**: Shows the details of a specific task. Supports comma-separated task IDs for bulk retrieval (e.g., `"1,2,3"` or `"HAM-123,1.2"`).
|
||||
- **`next_task`**: Shows the next task to work on.
|
||||
- **`set_task_status`**: Sets the status of a task or subtask.
|
||||
- **`set_task_status`**: Sets the status of a task or subtask. Supports comma-separated task IDs for bulk status updates (e.g., `"1.2,3.4"` or `"HAM-123,PROJ-456"`).
|
||||
|
||||
### 3. Task Analysis and Expansion
|
||||
|
||||
|
||||
@@ -4,13 +4,32 @@ sidebarTitle: "Task Structure"
|
||||
description: "Tasks in Task Master follow a specific format designed to provide comprehensive information for both humans and AI assistants."
|
||||
---
|
||||
|
||||
## Task ID Formats
|
||||
|
||||
Task Master supports multiple task ID formats depending on storage mode:
|
||||
|
||||
| Format | Examples | Description |
|
||||
|--------|----------|-------------|
|
||||
| **Numeric** | `1`, `15`, `999` | Simple numeric IDs (local file storage) |
|
||||
| **Numeric Subtasks** | `1.2`, `15.3.1`, `2.1.4` | Dot notation for subtasks (local file storage) |
|
||||
| **Alphanumeric Display IDs** | `HAM-123`, `PROJ-456` | Display IDs for remote API storage (main tasks only) |
|
||||
|
||||
**Note**: Alphanumeric IDs with dot notation (e.g., `HAM-123.2`) are not supported. In remote mode, subtasks also use alphanumeric IDs like `HAM-2`, `HAM-3` without dot notation.
|
||||
|
||||
### Supported Operations with Task IDs
|
||||
|
||||
- **Single task**: `task-master show 1` or `task-master show HAM-123`
|
||||
- **Subtask**: `task-master show 1.2` (local storage only)
|
||||
- **Multiple tasks**: `task-master set-status --id=1,2,3 --status=done`
|
||||
- **Mixed formats**: `task-master set-status --id=1.2,HAM-123 --status=done`
|
||||
|
||||
## Task Fields in tasks.json
|
||||
|
||||
Tasks in tasks.json have the following structure:
|
||||
|
||||
| Field | Description | Example |
|
||||
| -------------- | ---------------------------------------------- | ------------------------------------------------------ |
|
||||
| `id` | Unique identifier for the task. | `1` |
|
||||
| `id` | Unique identifier for the task. | `1`, `HAM-123` |
|
||||
| `title` | Brief, descriptive title. | `"Initialize Repo"` |
|
||||
| `description` | What the task involves. | `"Create a new repository, set up initial structure."` |
|
||||
| `status` | Current state. | `"pending"`, `"done"`, `"deferred"` |
|
||||
|
||||
@@ -46,6 +46,10 @@ description: "A comprehensive reference of all available Task Master commands"
|
||||
|
||||
# View a specific subtask (e.g., subtask 2 of task 1)
|
||||
task-master show 1.2
|
||||
|
||||
# Show multiple tasks at once (comma-separated)
|
||||
task-master show 1,2,3
|
||||
task-master show 1.2,3.4,HAM-123
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
@@ -98,6 +102,12 @@ description: "A comprehensive reference of all available Task Master commands"
|
||||
|
||||
# Set status for subtasks
|
||||
task-master set-status --id=1.1,1.2 --status=<status>
|
||||
|
||||
# Set status for alphanumeric display IDs (remote storage)
|
||||
task-master set-status --id=HAM-123,PROJ-456 --status=<status>
|
||||
|
||||
# Mixed formats work together
|
||||
task-master set-status --id=1,HAM-123,2.1 --status=<status>
|
||||
```
|
||||
|
||||
When marking a task as "done", all of its subtasks will automatically be marked as "done" as well.
|
||||
|
||||
@@ -30,6 +30,7 @@ description: "Configure Task Master through environment variables in a .env file
|
||||
| `PROJECT_VERSION` | `"1.0.0"` | Version in metadata | `PROJECT_VERSION=2.1.0` |
|
||||
| `PERPLEXITY_API_KEY` | - | For research-backed features | `PERPLEXITY_API_KEY=pplx-...` |
|
||||
| `PERPLEXITY_MODEL` | `"sonar-medium-online"` | Perplexity model | `PERPLEXITY_MODEL=sonar-large-online` |
|
||||
| `TM_HIDE_BANNER` | `"false"` | Hide ASCII art banner | `TM_HIDE_BANNER=true` |
|
||||
|
||||
## TDD Workflow Configuration
|
||||
|
||||
|
||||
62
output.txt
Normal file
62
output.txt
Normal file
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user