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: Hamster Integration - Cloud Storage, Sentry Telemetry, and Major CLI UX Improvements (#1452)\n\n\n\n Co-authored-by: Claude <claude-assistant@anthropic.com>
This commit is contained in:
github-actions[bot]
197
apps/docs/capabilities/hamster-integration.mdx
Normal file
197
apps/docs/capabilities/hamster-integration.mdx
Normal file
@@ -0,0 +1,197 @@
|
||||
---
|
||||
title: "Hamster Integration"
|
||||
sidebarTitle: "Hamster Integration"
|
||||
---
|
||||
|
||||
Task Master integrates seamlessly with Hamster, a team collaboration platform for AI-driven development. This integration enables you to move from solo development with local tasks to collaborative team workflows.
|
||||
|
||||
## Overview
|
||||
|
||||
Hamster integration offers two key benefits:
|
||||
|
||||
1. **Team Collaboration**: Share your task plans with teammates through collaborative briefs
|
||||
2. **No API Keys Required**: Hamster handles all AI inference, removing the need to manage your own API keys
|
||||
|
||||
## Workflow Options
|
||||
|
||||
When you run `task-master init`, you can choose between two workflows:
|
||||
|
||||
### Solo Workflow (Taskmaster)
|
||||
- Parse PRD → structured tasks → AI agent executes with local control
|
||||
- Tasks stored locally in JSON files
|
||||
- Requires your own AI API keys
|
||||
- Great for individual development and prototyping
|
||||
|
||||
### Team Workflow (Hamster)
|
||||
- Team writes brief → Hamster refines → aligned execution with Taskmaster
|
||||
- Tasks live in cloud with real-time sync
|
||||
- No API keys needed - Hamster provides AI inference
|
||||
- Enables team collaboration and shared context
|
||||
|
||||
## Getting Started with Hamster
|
||||
|
||||
### 1. Authentication
|
||||
|
||||
First, login to Hamster to enable team features:
|
||||
|
||||
```bash
|
||||
# OAuth login flow
|
||||
task-master login
|
||||
|
||||
# For SSH/remote environments, use token-based login
|
||||
task-master login <your-token>
|
||||
|
||||
# Check authentication status
|
||||
task-master auth status
|
||||
```
|
||||
|
||||
### 2. Create Team Briefs
|
||||
|
||||
You have several options for creating collaborative briefs:
|
||||
|
||||
#### From PRD (Parse to Hamster)
|
||||
```bash
|
||||
# Parse PRD directly to Hamster instead of local tasks
|
||||
task-master parse-prd your-prd.md --hamster
|
||||
```
|
||||
|
||||
This will:
|
||||
- Create a new brief on Hamster with auto-generated title/description
|
||||
- Generate tasks on the platform (no local JSON files)
|
||||
- Show progress with real-time updates
|
||||
- Allow you to invite teammates during creation
|
||||
- Set your CLI context to the new brief
|
||||
|
||||
#### Export Existing Tasks
|
||||
```bash
|
||||
# Export all local tasks to a new Hamster brief
|
||||
task-master export
|
||||
|
||||
# Export specific tags
|
||||
task-master export frontend,backend
|
||||
|
||||
# Export and invite team members
|
||||
task-master export --invite teammate1@company.com,teammate2@company.com
|
||||
```
|
||||
|
||||
The export process:
|
||||
- Reverse-engineers your PRD from existing tasks
|
||||
- Creates a comprehensive brief with context
|
||||
- Imports all tasks atomically
|
||||
- Provides shareable URLs for team collaboration
|
||||
|
||||
## Team Collaboration Features
|
||||
|
||||
### Invite Team Members
|
||||
|
||||
During brief creation, you can invite up to 10 teammates:
|
||||
|
||||
```bash
|
||||
# Using the --invite flag
|
||||
task-master export --invite user1@example.com,user2@example.com
|
||||
|
||||
# Or use the short form
|
||||
task-master export -I user1@example.com,user2@example.com
|
||||
```
|
||||
|
||||
The system will show invitation status:
|
||||
- ✅ Invitation sent successfully
|
||||
- ✅ User is already a team member
|
||||
- ❌ Error sending invitation
|
||||
|
||||
### Real-time Sync
|
||||
|
||||
When connected to Hamster:
|
||||
- Tasks sync in real-time across your team
|
||||
- Changes made by teammates appear instantly
|
||||
- Context is shared and maintained across the team
|
||||
- All team members see the same task state
|
||||
|
||||
### Contextual UI
|
||||
|
||||
Task Master automatically detects Hamster connection and provides context-aware UI:
|
||||
|
||||
- Shows `Brief: [name]` instead of `tag: [name]`
|
||||
- Displays Hamster-specific command help
|
||||
- Progress indicators for cloud operations
|
||||
- Clickable URLs for brief and team invites
|
||||
|
||||
## Command Reference
|
||||
|
||||
### Authentication Commands
|
||||
```bash
|
||||
task-master login [token] # Login to Hamster
|
||||
task-master logout # Logout from Hamster
|
||||
task-master auth status # Check auth status
|
||||
```
|
||||
|
||||
### Brief Management
|
||||
```bash
|
||||
task-master parse-prd <file> --hamster # Create brief from PRD
|
||||
task-master export [tags] # Export tasks to brief
|
||||
task-master export --invite <emails> # Export with team invites
|
||||
task-master export --dry-run # Preview export
|
||||
```
|
||||
|
||||
### Task Operations
|
||||
All standard Task Master commands work with Hamster briefs:
|
||||
```bash
|
||||
task-master list # List brief tasks
|
||||
task-master next # Get next task
|
||||
task-master status <id> <status> # Update task status
|
||||
task-master update-task <id> <text> # Update with AI (via Hamster)
|
||||
```
|
||||
|
||||
## Privacy and Telemetry
|
||||
|
||||
When using Hamster integration:
|
||||
|
||||
- **Data Location**: Tasks and briefs are stored securely on Hamster's platform
|
||||
- **AI Processing**: All AI operations are handled by Hamster's infrastructure
|
||||
- **Telemetry**: Anonymous usage telemetry is collected to improve the service
|
||||
- **Opt-out**: You can disable telemetry with `anonymousTelemetry: false` in config
|
||||
|
||||
## Best Practices
|
||||
|
||||
### When to Use Hamster
|
||||
- **Team Projects**: When collaborating with multiple developers
|
||||
- **Client Work**: When you need to share progress and context
|
||||
- **API Key Management**: When you want to avoid managing multiple AI API keys
|
||||
- **Real-time Collaboration**: When team members need synchronized task updates
|
||||
|
||||
### When to Use Solo Workflow
|
||||
- **Personal Projects**: Individual development work
|
||||
- **Prototyping**: Quick experimentation and iteration
|
||||
- **Sensitive Code**: When you need complete local control
|
||||
- **Custom AI Setup**: When you have specific AI model preferences
|
||||
|
||||
### Migration Between Workflows
|
||||
|
||||
You can easily move between workflows:
|
||||
|
||||
1. **Solo → Team**: Use `task-master export` to move local tasks to Hamster
|
||||
2. **Team → Solo**: Download tasks from Hamster brief and import locally (coming soon)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Authentication Issues
|
||||
```bash
|
||||
# Clear auth cache and re-login
|
||||
task-master logout
|
||||
task-master login
|
||||
|
||||
# Check authentication status
|
||||
task-master auth status
|
||||
```
|
||||
|
||||
### Sync Issues
|
||||
- Ensure stable internet connection
|
||||
- Check Hamster service status
|
||||
- Re-authenticate if needed
|
||||
|
||||
### API Key Conflicts
|
||||
When using Hamster, you don't need local AI API keys. If you have both configured, Hamster takes precedence for team briefs.
|
||||
|
||||
---
|
||||
|
||||
For more information about Hamster's features and pricing, visit [hamster.ai](https://hamster.ai).
|
||||
@@ -6,12 +6,17 @@ description: "A comprehensive reference of all available Task Master commands"
|
||||
<AccordionGroup>
|
||||
<Accordion title="Parse PRD">
|
||||
```bash
|
||||
# Parse a PRD file and generate tasks
|
||||
# Parse a PRD file and generate tasks locally
|
||||
task-master parse-prd <prd-file.txt>
|
||||
|
||||
# Parse to Hamster (team collaboration platform)
|
||||
task-master parse-prd <prd-file.txt> --hamster
|
||||
|
||||
# Limit the number of tasks generated
|
||||
task-master parse-prd <prd-file.txt> --num-tasks=10
|
||||
```
|
||||
|
||||
When using `--hamster`, you can choose to create a brief on Hamster instead of local tasks. This enables team collaboration, real-time sync, and removes the need for API keys as Hamster handles AI inference.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="List Tasks">
|
||||
@@ -19,14 +24,17 @@ description: "A comprehensive reference of all available Task Master commands"
|
||||
# List all tasks
|
||||
task-master list
|
||||
|
||||
# List tasks with a specific status
|
||||
# List tasks with a specific status (new positional syntax)
|
||||
task-master list done
|
||||
task-master list in-progress
|
||||
task-master list pending
|
||||
|
||||
# List all tasks including subtasks (shorthand)
|
||||
task-master list all
|
||||
|
||||
# Legacy flag syntax (still supported)
|
||||
task-master list --status=<status>
|
||||
|
||||
# List tasks with subtasks
|
||||
task-master list --with-subtasks
|
||||
|
||||
# List tasks with a specific status and include subtasks
|
||||
task-master list --status=<status> --with-subtasks
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
@@ -58,11 +66,18 @@ description: "A comprehensive reference of all available Task Master commands"
|
||||
|
||||
<Accordion title="Update a Specific Task">
|
||||
```bash
|
||||
# Update a single task by ID with new information
|
||||
# Update a single task by ID with new information (new positional syntax)
|
||||
task-master update-task <id> <prompt>
|
||||
|
||||
# Examples with positional syntax (no quotes needed for multi-word prompts)
|
||||
task-master update-task 1 Added implementation notes
|
||||
task-master update-task 2.1 Updated API requirements
|
||||
|
||||
# Legacy flag syntax (still supported)
|
||||
task-master update-task --id=<id> --prompt="<prompt>"
|
||||
|
||||
# Use research-backed updates with Perplexity AI
|
||||
task-master update-task --id=<id> --prompt="<prompt>" --research
|
||||
task-master update-task <id> <prompt> --research
|
||||
```
|
||||
</Accordion>
|
||||
|
||||
@@ -90,14 +105,21 @@ description: "A comprehensive reference of all available Task Master commands"
|
||||
|
||||
<Accordion title="Set Task Status">
|
||||
```bash
|
||||
# Set status of a single task
|
||||
task-master set-status --id=<id> --status=<status>
|
||||
# Set status of a single task (new positional syntax)
|
||||
task-master set-status <id> <status>
|
||||
# or use the new alias
|
||||
task-master status <id> <status>
|
||||
|
||||
# Examples with positional syntax
|
||||
task-master status 1 done
|
||||
task-master status 2.1 in-progress
|
||||
task-master set-status 3 pending
|
||||
|
||||
# Set status for multiple tasks
|
||||
task-master set-status --id=1,2,3 --status=<status>
|
||||
task-master set-status 1,2,3 in-progress
|
||||
|
||||
# Set status for subtasks
|
||||
task-master set-status --id=1.1,1.2 --status=<status>
|
||||
# Legacy flag syntax (still supported)
|
||||
task-master set-status --id=<id> --status=<status>
|
||||
```
|
||||
|
||||
When marking a task as "done", all of its subtasks will automatically be marked as "done" as well.
|
||||
@@ -203,7 +225,62 @@ description: "A comprehensive reference of all available Task Master commands"
|
||||
```bash
|
||||
# Initialize a new project with Task Master structure
|
||||
task-master init
|
||||
|
||||
# Non-interactive setup with defaults
|
||||
task-master init --yes
|
||||
|
||||
# Pre-configure AI IDE rules during init
|
||||
task-master init --rules cursor,windsurf
|
||||
```
|
||||
|
||||
The new init flow offers two workflow choices:
|
||||
- **Solo (Taskmaster)**: Parse PRD → structured tasks → AI agent executes with control
|
||||
- **Together (Hamster)**: Team writes brief → Hamster refines → aligned execution with Taskmaster
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Export Tasks to Hamster">
|
||||
```bash
|
||||
# Export local tasks to collaborative Hamster briefs
|
||||
task-master export
|
||||
|
||||
# Export specific tags
|
||||
task-master export tag1,tag2
|
||||
|
||||
# Export and invite team members during creation
|
||||
task-master export --invite user1@example.com,user2@example.com
|
||||
# or
|
||||
task-master export -I user1@example.com,user2@example.com
|
||||
|
||||
# Preview what would be exported without creating a brief
|
||||
task-master export --dry-run
|
||||
```
|
||||
|
||||
Export transforms your local tasks into shareable team briefs on Hamster. The platform reverse-engineers your PRD from tasks and enables real-time team collaboration. No API keys required - Hamster handles all AI inference.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Authentication (Login/Logout)">
|
||||
```bash
|
||||
# Login to Hamster (OAuth flow)
|
||||
task-master login
|
||||
# or
|
||||
task-master auth login
|
||||
|
||||
# Login with token (for SSH/remote environments)
|
||||
task-master login <token>
|
||||
|
||||
# Skip interactive prompts
|
||||
task-master login --yes
|
||||
|
||||
# Logout from Hamster
|
||||
task-master logout
|
||||
# or
|
||||
task-master auth logout
|
||||
|
||||
# Check authentication status
|
||||
task-master auth status
|
||||
```
|
||||
|
||||
Authentication is required for Hamster integration (export, parse-prd --hamster). The login flow uses OAuth for security and convenience.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="TDD Workflow (Autopilot)">
|
||||
|
||||
@@ -48,6 +48,7 @@
|
||||
{
|
||||
"group": "Technical Capabilities",
|
||||
"pages": [
|
||||
"capabilities/hamster-integration",
|
||||
"capabilities/mcp",
|
||||
"capabilities/cli-root-commands",
|
||||
"capabilities/task-structure"
|
||||
@@ -74,6 +75,16 @@
|
||||
"anchor": "Discord",
|
||||
"href": "https://discord.gg/fWJkU7rf",
|
||||
"icon": "discord"
|
||||
},
|
||||
{
|
||||
"anchor": "What's New",
|
||||
"href": "/whats-new",
|
||||
"icon": "sparkles"
|
||||
},
|
||||
{
|
||||
"anchor": "Command Reference",
|
||||
"href": "/command-reference",
|
||||
"icon": "terminal"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -4,9 +4,16 @@ sidebarTitle: "Configuration"
|
||||
|
||||
---
|
||||
|
||||
Before getting started with Task Master, you'll need to set up your API keys. There are a couple of ways to do this depending on whether you're using the CLI or working inside MCP. It's also a good time to start getting familiar with the other configuration options available — even if you don’t need to adjust them yet, knowing what’s possible will help down the line.
|
||||
Before getting started with Task Master, you'll need to configure your workflow. Task Master offers two options: Solo workflow (requires API keys) or Team workflow with Hamster (no API keys needed).
|
||||
|
||||
## API Key Setup
|
||||
## Choose Your Workflow
|
||||
|
||||
During `task-master init`, you'll be prompted to choose between:
|
||||
|
||||
1. **Solo (Taskmaster)**: Parse PRD → structured tasks → AI agent executes with local control
|
||||
2. **Together (Hamster)**: Team writes brief → Hamster refines → aligned execution
|
||||
|
||||
### For Solo Workflow: API Key Setup
|
||||
|
||||
Task Master uses environment variables to securely store provider API keys and optional endpoint URLs.
|
||||
|
||||
@@ -83,6 +90,24 @@ PERPLEXITY_API_KEY=pplx-your-key-here
|
||||
# VERTEX_PROJECT_ID=your-gcp-project-id
|
||||
```
|
||||
|
||||
### For Team Workflow: Hamster Setup
|
||||
|
||||
If you choose the Hamster workflow, configuration is much simpler:
|
||||
|
||||
1. **No API Keys Required**: Hamster provides all AI inference
|
||||
2. **Authentication**: Login during init or manually with `task-master login`
|
||||
3. **Team Collaboration**: Invite teammates when creating briefs
|
||||
4. **Real-time Sync**: All configuration is managed on Hamster platform
|
||||
|
||||
```bash
|
||||
# Initialize with Hamster workflow
|
||||
task-master init
|
||||
# Choose "Together (Hamster)" when prompted
|
||||
|
||||
# Or login manually anytime
|
||||
task-master login
|
||||
```
|
||||
|
||||
## What Else Can Be Configured?
|
||||
|
||||
The main configuration file (`.taskmaster/config.json`) allows you to control nearly every aspect of Task Master’s behavior. Here’s a high-level look at what you can customize:
|
||||
|
||||
@@ -5,10 +5,14 @@ sidebarTitle: "Quick Start"
|
||||
|
||||
This guide is for new users who want to start using Task Master with minimal setup time.
|
||||
|
||||
Task Master offers two workflow options:
|
||||
- **Solo Workflow**: Individual development with local task management
|
||||
- **Team Workflow**: Collaborative development using Hamster integration
|
||||
|
||||
It covers:
|
||||
- [Requirements](/getting-started/quick-start/requirements): You will need Node.js and an AI model API Key.
|
||||
- [Requirements](/getting-started/quick-start/requirements): You will need Node.js and optionally an AI model API Key.
|
||||
- [Installation](/getting-started/quick-start/installation): How to Install Task Master.
|
||||
- [Configuration](/getting-started/quick-start/configuration-quick): Setting up your API Key, MCP, and more.
|
||||
- [Configuration](/getting-started/quick-start/configuration-quick): Setting up your workflow, API Keys, MCP, and more.
|
||||
- [PRD](/getting-started/quick-start/prd-quick): Writing and parsing your first PRD.
|
||||
- [Task Setup](/getting-started/quick-start/tasks-quick): Preparing your tasks for execution.
|
||||
- [Executing Tasks](/getting-started/quick-start/execute-quick): Using Task Master to execute tasks.
|
||||
|
||||
@@ -2,7 +2,12 @@
|
||||
title: Requirements
|
||||
sidebarTitle: "Requirements"
|
||||
---
|
||||
Before you can start using TaskMaster AI, you'll need to install Node.js and set up at least one model API Key.
|
||||
Before you can start using TaskMaster AI, you'll need to install Node.js. Depending on your workflow choice, you may also need AI model API keys.
|
||||
|
||||
## Workflow Options
|
||||
|
||||
**Solo Workflow (Local)**: Requires Node.js + AI API Keys
|
||||
**Team Workflow (Hamster)**: Requires Node.js + Hamster account (no API keys needed)
|
||||
|
||||
## 1. Node.js
|
||||
|
||||
@@ -33,7 +38,9 @@ winget install OpenJS.NodeJS
|
||||
|
||||
</Accordion>
|
||||
|
||||
## 2. Model API Key
|
||||
## 2. AI Model Setup
|
||||
|
||||
### For Solo Workflow (Local)
|
||||
|
||||
Taskmaster utilizes AI across several commands, and those require a separate API key. For the purpose of a Quick Start we recommend setting up an API Key with Anthropic for your main model and Perplexity for your research model (optional but recommended).
|
||||
|
||||
@@ -47,4 +54,22 @@ At least one (1) of the following is required:
|
||||
4. Perplexity API key (for research model)
|
||||
5. xAI API Key (for research or main model)
|
||||
6. OpenRouter API Key (for research or main model)
|
||||
7. Claude Code (no API key required - requires Claude Code CLI)
|
||||
7. Claude Code (no API key required - requires Claude Code CLI)
|
||||
|
||||
### For Team Workflow (Hamster)
|
||||
|
||||
When using Hamster integration, you don't need any AI API keys. Hamster provides all AI inference through their platform.
|
||||
|
||||
**What you need:**
|
||||
1. **Hamster Account**: Sign up at [hamster.ai](https://hamster.ai)
|
||||
2. **Internet Connection**: Required for real-time team sync
|
||||
3. **Team Members** (optional): Invite teammates via email during brief creation
|
||||
|
||||
**Benefits of Hamster Workflow:**
|
||||
- ✅ No API key management required
|
||||
- ✅ Real-time team collaboration
|
||||
- ✅ Centralized task storage
|
||||
- ✅ Built-in AI inference
|
||||
- ✅ Shared context across team members
|
||||
|
||||
You can always switch between workflows or use both depending on your project needs.
|
||||
@@ -3,4 +3,81 @@ title: "What's New"
|
||||
sidebarTitle: "What's New"
|
||||
---
|
||||
|
||||
An easy way to see the latest releases
|
||||
## Latest Release: Hamster Integration & Major UX Improvements
|
||||
|
||||
### 🎯 Team Collaboration with Hamster
|
||||
|
||||
Task Master now integrates with Hamster, enabling seamless team collaboration:
|
||||
|
||||
- **Two Workflow Options**: Choose between Solo (local tasks) or Team (Hamster collaboration) during `task-master init`
|
||||
- **No API Keys for Teams**: Hamster handles all AI inference when using team workflow
|
||||
- **Real-time Sync**: Tasks sync instantly across your entire team
|
||||
- **Export to Hamster**: Transform local tasks into collaborative briefs with `task-master export`
|
||||
- **Parse to Hamster**: Create team briefs directly from PRDs with `task-master parse-prd --hamster`
|
||||
|
||||
### 🚀 New Commands
|
||||
|
||||
**Authentication Shortcuts**
|
||||
```bash
|
||||
task-master login # Quick OAuth login to Hamster
|
||||
task-master logout # Logout from Hamster
|
||||
```
|
||||
|
||||
**Export & Collaboration**
|
||||
```bash
|
||||
task-master export # Export tasks to Hamster
|
||||
task-master export --invite user@team.com # Export and invite teammates
|
||||
```
|
||||
|
||||
### ⚡ Simplified Command Syntax
|
||||
|
||||
**New Positional Arguments** (backward compatible):
|
||||
```bash
|
||||
# Before (still works)
|
||||
task-master set-status --id=1 --status=done
|
||||
task-master update-task --id=2 --prompt="Updated requirements"
|
||||
|
||||
# Now (simpler)
|
||||
task-master status 1 done
|
||||
task-master update-task 2 Updated requirements
|
||||
```
|
||||
|
||||
**Smart Shortcuts**:
|
||||
- `task-master list done` - List completed tasks
|
||||
- `task-master list all` - Show all tasks including subtasks
|
||||
- `task-master status` - New alias for `set-status`
|
||||
|
||||
### 🔧 Enhanced UX
|
||||
|
||||
**Context-Aware Interface**
|
||||
- Shows `Brief: [name]` when connected to Hamster
|
||||
- Hamster-specific command help and examples
|
||||
- Progress indicators for cloud operations
|
||||
- Cleaner, less noisy output
|
||||
|
||||
**Improved `init` Workflow**
|
||||
- Clear workflow selection with guided setup
|
||||
- Optional AI IDE rules configuration
|
||||
- Reduced log noise (15+ debug-level messages)
|
||||
- Non-interactive mode with `--yes` flag
|
||||
|
||||
### 📊 Telemetry & Monitoring
|
||||
|
||||
**Sentry Integration**
|
||||
- Comprehensive error tracking for better reliability
|
||||
- AI operation monitoring (token usage, performance)
|
||||
- MCP server instrumentation
|
||||
- Privacy-respecting anonymous telemetry (opt-out available)
|
||||
|
||||
### 🛠️ Quality of Life
|
||||
|
||||
- **Display Improvements**: Better task rendering with HTML/Markdown support
|
||||
- **ID Shortcuts**: `tm show ham31` normalizes to `HAM-31`
|
||||
- **Clickable URLs**: Terminal links for briefs and team invites
|
||||
- **Smart Messaging**: Better error handling and user feedback
|
||||
|
||||
---
|
||||
|
||||
## Previous Releases
|
||||
|
||||
For complete release history, see the [CHANGELOG](/CHANGELOG).
|
||||
98
output.txt
Normal file
98
output.txt
Normal file
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user