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: add tm tags command to remote (#1386)\n\nCo-authored-by: Claude <noreply@anthropic.com>\n\n Co-authored-by: Claude <claude-assistant@anthropic.com>
This commit is contained in:
github-actions[bot]
@@ -206,4 +206,90 @@ sidebarTitle: "CLI Commands"
|
||||
task-master init
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Tags Management">
|
||||
```bash
|
||||
# List all tags with statistics (default action)
|
||||
task-master tags
|
||||
task-master tags list
|
||||
task-master tags list --show-metadata
|
||||
|
||||
# Create a new tag
|
||||
task-master tags add <name>
|
||||
task-master tags add <name> --description "Tag description"
|
||||
task-master tags add <name> --copy-from <other-tag>
|
||||
task-master tags add --from-branch # Create from git branch name
|
||||
|
||||
# Switch to a different tag
|
||||
task-master tags use <name>
|
||||
task-master tags use <id> # Use tag ID (last 8 chars)
|
||||
|
||||
# Remove a tag (deletes all tasks in the tag)
|
||||
task-master tags remove <name>
|
||||
task-master tags remove <name> -y # Skip confirmation
|
||||
|
||||
# Rename a tag
|
||||
task-master tags rename <old-name> <new-name>
|
||||
|
||||
# Copy a tag with all its tasks
|
||||
task-master tags copy <source> <target>
|
||||
task-master tags copy <source> <target> --description "Description"
|
||||
```
|
||||
|
||||
Tags help organize tasks into different contexts or workstreams. Works with both local file storage and API storage (tryhamster.com).
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Briefs Management (API Only)">
|
||||
```bash
|
||||
# List all briefs (API storage only)
|
||||
task-master briefs
|
||||
task-master briefs list
|
||||
task-master briefs list --show-metadata
|
||||
|
||||
# Select a brief by URL or ID
|
||||
task-master briefs <brief-url-or-id>
|
||||
task-master briefs select <brief-url-or-id>
|
||||
|
||||
# Create a new brief (opens web UI)
|
||||
task-master briefs create
|
||||
```
|
||||
|
||||
Briefs are a friendly alias for tags when using API storage (tryhamster.com). This command only works when authenticated.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Authentication">
|
||||
```bash
|
||||
# Log in to tryhamster.com
|
||||
task-master auth login
|
||||
|
||||
# Log out
|
||||
task-master auth logout
|
||||
|
||||
# Check authentication status
|
||||
task-master auth status
|
||||
|
||||
# Refresh authentication token
|
||||
task-master auth refresh
|
||||
```
|
||||
|
||||
Authentication enables API storage features and team collaboration through tryhamster.com.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Context Management">
|
||||
```bash
|
||||
# Show current context (organization/brief)
|
||||
task-master context
|
||||
|
||||
# Set organization context
|
||||
task-master context set-org <organization-id>
|
||||
|
||||
# Set brief context
|
||||
task-master context set-brief <brief-id>
|
||||
|
||||
# Clear context
|
||||
task-master context clear
|
||||
```
|
||||
|
||||
Context management helps you work within specific organizations and briefs when using API storage.
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
@@ -206,6 +206,92 @@ description: "A comprehensive reference of all available Task Master commands"
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Tags Management">
|
||||
```bash
|
||||
# List all tags with statistics (default action)
|
||||
task-master tags
|
||||
task-master tags list
|
||||
task-master tags list --show-metadata
|
||||
|
||||
# Create a new tag
|
||||
task-master tags add <name>
|
||||
task-master tags add <name> --description "Tag description"
|
||||
task-master tags add <name> --copy-from <other-tag>
|
||||
task-master tags add --from-branch # Create from git branch name
|
||||
|
||||
# Switch to a different tag
|
||||
task-master tags use <name>
|
||||
task-master tags use <id> # Use tag ID (last 8 chars)
|
||||
|
||||
# Remove a tag (deletes all tasks in the tag)
|
||||
task-master tags remove <name>
|
||||
task-master tags remove <name> -y # Skip confirmation
|
||||
|
||||
# Rename a tag
|
||||
task-master tags rename <old-name> <new-name>
|
||||
|
||||
# Copy a tag with all its tasks
|
||||
task-master tags copy <source> <target>
|
||||
task-master tags copy <source> <target> --description "Description"
|
||||
```
|
||||
|
||||
Tags help organize tasks into different contexts or workstreams. Works with both local file storage and API storage (tryhamster.com).
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Briefs Management (API Only)">
|
||||
```bash
|
||||
# List all briefs (API storage only)
|
||||
task-master briefs
|
||||
task-master briefs list
|
||||
task-master briefs list --show-metadata
|
||||
|
||||
# Select a brief by URL or ID
|
||||
task-master briefs <brief-url-or-id>
|
||||
task-master briefs select <brief-url-or-id>
|
||||
|
||||
# Create a new brief (opens web UI)
|
||||
task-master briefs create
|
||||
```
|
||||
|
||||
Briefs are a friendly alias for tags when using API storage (tryhamster.com). This command only works when authenticated.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Authentication">
|
||||
```bash
|
||||
# Log in to tryhamster.com
|
||||
task-master auth login
|
||||
|
||||
# Log out
|
||||
task-master auth logout
|
||||
|
||||
# Check authentication status
|
||||
task-master auth status
|
||||
|
||||
# Refresh authentication token
|
||||
task-master auth refresh
|
||||
```
|
||||
|
||||
Authentication enables API storage features and team collaboration through tryhamster.com.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Context Management">
|
||||
```bash
|
||||
# Show current context (organization/brief)
|
||||
task-master context
|
||||
|
||||
# Set organization context
|
||||
task-master context set-org <organization-id>
|
||||
|
||||
# Set brief context
|
||||
task-master context set-brief <brief-id>
|
||||
|
||||
# Clear context
|
||||
task-master context clear
|
||||
```
|
||||
|
||||
Context management helps you work within specific organizations and briefs when using API storage.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="TDD Workflow (Autopilot)">
|
||||
```bash
|
||||
# Start autonomous TDD workflow for a task
|
||||
|
||||
@@ -31,6 +31,25 @@ description: "Configure Task Master through environment variables in a .env file
|
||||
| `PERPLEXITY_API_KEY` | - | For research-backed features | `PERPLEXITY_API_KEY=pplx-...` |
|
||||
| `PERPLEXITY_MODEL` | `"sonar-medium-online"` | Perplexity model | `PERPLEXITY_MODEL=sonar-large-online` |
|
||||
|
||||
## Storage Configuration
|
||||
|
||||
Task Master supports two storage modes:
|
||||
|
||||
| Variable | Default | Description | Example |
|
||||
| --- | --- | --- | --- |
|
||||
| `STORAGE_TYPE` | `"file"` | Storage backend | `STORAGE_TYPE=api` |
|
||||
| `API_BASE_URL` | - | API server URL for remote storage | `API_BASE_URL=https://api.tryhamster.com` |
|
||||
|
||||
### Local File Storage (Default)
|
||||
Tasks are stored locally in `.taskmaster/tasks/tasks.json`. No authentication required.
|
||||
|
||||
### API Storage
|
||||
Tasks are stored remotely on tryhamster.com. Requires authentication via `task-master auth login`.
|
||||
|
||||
<Note>
|
||||
When using API storage, you can collaborate with team members and access tasks from multiple devices.
|
||||
</Note>
|
||||
|
||||
## TDD Workflow Configuration
|
||||
|
||||
Additional options for autonomous TDD workflow:
|
||||
@@ -66,6 +85,10 @@ DEFAULT_PRIORITY=medium
|
||||
DEBUG=false
|
||||
LOG_LEVEL=info
|
||||
|
||||
# Storage Configuration
|
||||
STORAGE_TYPE=file # or "api" for remote storage
|
||||
# API_BASE_URL=https://api.tryhamster.com # Required for API storage
|
||||
|
||||
# TDD Workflow
|
||||
TM_MAX_ATTEMPTS=3
|
||||
TM_AUTO_COMMIT=true
|
||||
|
||||
@@ -3,4 +3,26 @@ title: "What's New"
|
||||
sidebarTitle: "What's New"
|
||||
---
|
||||
|
||||
## Latest Features
|
||||
|
||||
### Tags & Brief Management
|
||||
Task Master now supports organizing tasks with **tags** and **briefs**:
|
||||
|
||||
- **`task-master tags`** - Manage tags for local and remote task organization
|
||||
- **`task-master briefs`** - Friendly alias for API-based brief management
|
||||
- Create, list, switch between, copy, and rename tags/briefs
|
||||
- Support for both local file storage and remote API storage
|
||||
|
||||
### Authentication & Team Collaboration
|
||||
New authentication system enables team collaboration:
|
||||
|
||||
- **`task-master auth`** - Login/logout from tryhamster.com
|
||||
- **`task-master context`** - Manage organization and brief context
|
||||
- Seamless switching between local and remote storage
|
||||
|
||||
### Enhanced Command Structure
|
||||
- Centralized command registry for better organization
|
||||
- Improved error handling and user feedback
|
||||
- Better CLI help and examples for all commands
|
||||
|
||||
An easy way to see the latest releases
|
||||
78
output.txt
Normal file
78
output.txt
Normal file
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user