docs: auto-update documentation based on changes in next branch

This PR was automatically generated to update documentation based on recent changes.

  Original commit: Ralph/update.from.main (#1481)\n\n\n

  Co-authored-by: Claude <claude-assistant@anthropic.com>
This commit is contained in:
github-actions[bot]
2025-12-03 13:49:51 +00:00
parent 8674007cce
commit 058c6f0635
8 changed files with 431 additions and 21 deletions

View File

@@ -0,0 +1,192 @@
---
title: "Hamster Team Integration"
description: "Collaborate with your team using Task Master's Hamster integration"
---
# Team Collaboration with Hamster
Task Master now integrates seamlessly with Hamster to enable team-based project management and AI-powered task execution. This integration lets you move beyond solo development to true collaborative workflows.
## Overview
The Hamster integration transforms Task Master from a solo tool into a team platform:
- **Shared Context**: Your entire team works from the same brief, ensuring alignment
- **No API Keys**: Hamster handles all AI operations, removing setup friction
- **Real-time Sync**: Tasks and updates sync across all team members instantly
- **Collaborative Planning**: Write and refine briefs together, then generate tasks
## Getting Started with Hamster
### 1. Initialize with Team Workflow
When you run `task-master init`, choose the **"Together (Hamster)"** workflow:
```bash
task-master init
```
This will:
- Skip local AI model configuration (Hamster handles this)
- Set up OAuth authentication with Hamster
- Configure your project for team collaboration
### 2. Authentication
Use the built-in authentication commands:
```bash
# Log in to Hamster
task-master login
# Log out of Hamster
task-master logout
```
## Working with Briefs
### Creating Briefs from PRDs
When you parse a PRD with Hamster integration, your document becomes a collaborative brief:
```bash
task-master parse-prd .taskmaster/docs/feature.md
```
Choose **"Bring it to Hamster"** and the system will:
1. **OAuth Login**: Authenticate with your Hamster account
2. **Brief Creation**: Convert your PRD into a structured brief
3. **Team Invites**: Optionally invite teammates during creation
4. **Task Generation**: Generate tasks with progress indicators
5. **Context Setting**: Automatically set your CLI context to the new brief
### Brief Features
- **Auto-generated titles and descriptions** from your PRD content
- **Progress tracking** during task generation phases
- **Clickable URLs** for easy access to briefs and team invites
- **Real-time collaboration** with your entire team
## Exporting Local Tasks to Team
Already have local tasks? Export them to create collaborative briefs:
```bash
# Export all local tasks to Hamster
task-master export
# Export and invite team members
task-master export --invite
# Export specific tags
task-master export --tags=feature,bug-fix
```
The export process:
- **Reverse engineers** your PRD from existing tasks
- **Creates collaborative brief** with auto-generated content
- **Invites team members** (up to 10 via email)
- **Syncs your context** to the new team brief
## Enhanced User Experience
### Hamster-Aware Commands
When connected to Hamster, Task Master provides optimized experiences:
- **Context-specific help**: Shows only relevant commands for team workflows
- **Progress indicators**: Loading spinners for long-running operations
- **Better displays**: Shows "Brief: [name]" instead of "tag: [name]"
- **Simplified updates**: Cleaner update displays without redundant info
### Improved Command Syntax
All the new positional argument syntax works seamlessly with Hamster:
```bash
# Set task status with new syntax
task-master status HAM-31 done
task-master status ham31.2 in-progress
# Update tasks with natural syntax
task-master update-task HAM-31 Added authentication logic
# List tasks by status
task-master list done
task-master list in-progress
```
### Task ID Flexibility
Hamster task IDs work naturally with case-insensitive matching:
```bash
# All of these work the same way
task-master show HAM-31
task-master show ham31
task-master show ham-31
```
## Team Benefits
### Alignment
- **Single source of truth**: Everyone works from the same brief
- **Shared context**: Team members see the same task breakdown
- **Coordinated execution**: No duplicate work or conflicting implementations
### Collaboration
- **Real-time updates**: Changes sync across all team members
- **Team invites**: Easy onboarding of new members
- **Collective intelligence**: Leverage team knowledge in task generation
### Simplified Setup
- **Zero API keys**: No individual API key management
- **Centralized AI**: Hamster handles all AI operations
- **Instant start**: New team members can start immediately
## Best Practices
### Brief Writing
- **Write collaboratively**: Use Hamster's brief editing to refine together
- **Include context**: More team context leads to better task generation
- **Define responsibilities**: Clarify who owns what parts of the brief
### Task Management
- **Regular syncs**: Use `task-master next` to stay aligned on priorities
- **Status updates**: Keep task statuses current for team visibility
- **Communication**: Use brief comments for coordination
### Workflow Integration
- **Branch alignment**: Create branches that match task assignments
- **PR references**: Reference Hamster task IDs in pull requests
- **Review coordination**: Coordinate code reviews through brief discussions
## Troubleshooting
### Authentication Issues
- Check your internet connection
- Ensure you have a valid Hamster account
- Try `task-master logout` then `task-master login` to refresh
### Sync Problems
- Verify you're connected to the correct brief
- Check that all team members are using the same brief context
- Contact your team admin if brief permissions are restricted
### Performance
- Use `task-master list` filters to focus on relevant tasks
- Consider organizing large briefs with clear task hierarchies
- Break down complex briefs into multiple focused ones
## Migration from Solo to Team
Already using Task Master solo? Here's how to migrate:
1. **Export existing tasks**: `task-master export --invite`
2. **Invite your team**: Add team members during export
3. **Switch context**: Your CLI automatically switches to the team brief
4. **Coordinate**: Share the brief URL with your team
5. **Continue working**: Use the same Task Master commands with team sync
The migration preserves all your task structure while adding team collaboration capabilities.

View File

@@ -6,12 +6,23 @@ 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>
# Limit the number of tasks generated
task-master parse-prd <prd-file.txt> --num-tasks=10
# Append tasks from a new PRD to existing tasks
task-master parse-prd <prd-file.txt> --append
# Send PRD to Hamster for team collaboration (interactive choice)
task-master parse-prd <prd-file.txt>
# When prompted, choose "Bring it to Hamster" for team workflow
```
**Workflow Choice**: When parsing a PRD, you can choose between:
- **Parse locally**: PRD becomes a task list in a local JSON file - great for solo work
- **Bring it to Hamster**: PRD becomes a living brief connected to your team, codebase, and agents
</Accordion>
<Accordion title="List Tasks">
@@ -19,13 +30,19 @@ description: "A comprehensive reference of all available Task Master commands"
# List all tasks
task-master list
# List tasks with a specific status
task-master list --status=<status>
# List tasks with a specific status (new positional syntax)
task-master list <status>
task-master list done
task-master list in-progress
task-master list pending
# List tasks with subtasks
task-master list all
# or
task-master list --with-subtasks
# List tasks with a specific status and include subtasks
# List tasks with a specific status using flags (still supported)
task-master list --status=<status>
task-master list --status=<status> --with-subtasks
```
</Accordion>
@@ -46,6 +63,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
# Works with Hamster task IDs (case-insensitive)
task-master show HAM-31
task-master show ham31 # Same as above
```
</Accordion>
@@ -58,10 +79,15 @@ 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
task-master update-task --id=<id> --prompt="<prompt>"
# Update a single task by ID with new information (new positional syntax)
task-master update-task <id> <prompt>
task-master update-task 1 Added implementation details
# Use research-backed updates with Perplexity AI
task-master update-task <id> <prompt> --research
# Traditional flag syntax (still supported)
task-master update-task --id=<id> --prompt="<prompt>"
task-master update-task --id=<id> --prompt="<prompt>" --research
```
</Accordion>
@@ -90,16 +116,23 @@ description: "A comprehensive reference of all available Task Master commands"
<Accordion title="Set Task Status">
```bash
# Set status of a single task
# Set status of a single task (new positional syntax)
task-master status <id> <status>
task-master status 1 done
task-master status 1.2 in-progress
# Set status for multiple tasks (new syntax)
task-master status 1,2,3 done
task-master set-status 1,1.1,2 in-progress
# Traditional flag syntax (still supported)
task-master set-status --id=<id> --status=<status>
# Set status for multiple tasks
task-master set-status --id=1,2,3 --status=<status>
# Set status for subtasks
task-master set-status --id=1.1,1.2 --status=<status>
```
**New alias**: `tm status` is now a shortcut for `tm set-status`.
When marking a task as "done", all of its subtasks will automatically be marked as "done" as well.
</Accordion>
@@ -203,7 +236,47 @@ description: "A comprehensive reference of all available Task Master commands"
```bash
# Initialize a new project with Task Master structure
task-master init
# Skip AI IDE rules setup prompt
task-master init --yes
# Specify rules upfront for specific IDEs
task-master init --rules cursor,windsurf
```
**Workflow Selection**: During initialization, you'll choose between:
- **Solo (Taskmaster)**: Parse PRD → structured tasks → AI agent executes with control
- **Together (Hamster)**: Team writes brief → Hamster refines → aligned execution with Taskmaster
The Hamster workflow includes OAuth login and skips Git/AI configuration (handled by Hamster).
</Accordion>
<Accordion title="Export Tasks to Team">
```bash
# Export local tasks to Hamster for team collaboration
task-master export
# Export and invite team members
task-master export --invite
task-master export -I
# Export specific tags
task-master export --tags=feature,bug-fix
```
Exports your local tasks to shareable team briefs on Hamster. Hamster will reverse engineer your PRD based on your tasks and generate brief titles and descriptions. Automatically sets your CLI context to the new brief.
</Accordion>
<Accordion title="Hamster Authentication">
```bash
# Log in to Hamster
task-master login
# Log out of Hamster
task-master logout
```
Manage your Hamster authentication for team collaboration features.
</Accordion>
<Accordion title="TDD Workflow (Autopilot)">

View File

@@ -48,6 +48,7 @@
{
"group": "Technical Capabilities",
"pages": [
"capabilities/hamster-integration",
"capabilities/mcp",
"capabilities/cli-root-commands",
"capabilities/task-structure"

View File

@@ -4,11 +4,20 @@ 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 dont need to adjust them yet, knowing whats possible will help down the line.
Before getting started with Task Master, you'll need to set up your workflow and configuration. Task Master offers two main approaches:
- **Solo (Taskmaster)**: Work independently with local tasks and your own API keys
- **Together (Hamster)**: Collaborate with your team using Hamster's cloud platform (no API keys required)
This guide covers both approaches. If you choose the Hamster workflow, you can skip the API key setup since Hamster handles all AI operations for you.
## API Key Setup
Task Master uses environment variables to securely store provider API keys and optional endpoint URLs.
<Note>
**Using Hamster Workflow?** If you plan to use the Team (Hamster) workflow, you can skip this API key setup entirely. Hamster handles all AI operations, so you only need a Hamster account. Jump to the [initialization step](/getting-started/quick-start/prd-quick) to get started.
</Note>
For the Solo (Taskmaster) workflow, Task Master uses environment variables to securely store provider API keys and optional endpoint URLs.
### MCP Usage: mcp.json file

View File

@@ -87,7 +87,9 @@ Place your PRD file in the `.taskmaster/docs` folder in your project.
# Parse your PRD into Tasks
This is where the Task Master magic begins.
This is where the Task Master magic begins. When you run the parse command, you'll be given a choice between two workflows.
## Workflow Selection
In Cursor's AI chat, instruct the agent to generate tasks from your PRD:
@@ -101,11 +103,33 @@ The agent will execute the following command which you can alternatively paste i
task-master parse-prd .taskmaster/docs/<prd-name>.md
```
This will:
You'll then be prompted to choose your workflow:
### Solo (Taskmaster) Workflow
- **Parse locally**: PRD becomes a task list in a local JSON file
- **Great for**: Quick prototyping, individual work, full control over AI models
- **Requires**: Your own API keys for AI providers
- **Result**: Tasks stored in `.taskmaster/tasks/tasks.json`
### Together (Hamster) Workflow
- **Bring it to Hamster**: PRD becomes a living brief connected to your team
- **Great for**: Team collaboration, sharing context, no API key management
- **Requires**: Hamster account (free)
- **Result**: Tasks stored in Hamster with real-time team sync
## What Happens Next
**Solo workflow**:
- Parse your PRD document
- Generate a structured `tasks.json` file with tasks, dependencies, priorities, and test strategies
**Hamster workflow**:
- OAuth login to Hamster
- Create brief directly from PRD content with auto-generated title/description
- Invite teammates during brief creation (optional)
- Progress bar showing task generation phases
- Auto-set context to new brief when complete
Now that you have written and parsed a PRD, you are ready to start setting up your tasks.

View File

@@ -3,13 +3,13 @@ title: Quick Start
sidebarTitle: "Quick Start"
---
This guide is for new users who want to start using Task Master with minimal setup time.
This guide is for new users who want to start using Task Master with minimal setup time. Task Master offers two main workflows: **Solo** (work independently with your own AI keys) or **Together** (collaborate with your team using Hamster's cloud platform).
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 (not required for Hamster workflow).
- [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.
- [PRD](/getting-started/quick-start/prd-quick): Writing and parsing your first PRD.
- [Configuration](/getting-started/quick-start/configuration-quick): Setting up your workflow choice, API Keys (Solo), or Hamster authentication (Together).
- [PRD](/getting-started/quick-start/prd-quick): Writing and parsing your first PRD with workflow selection.
- [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.
- [Rules & Context](/getting-started/quick-start/rules-quick): Learn how and why to build context in your project over time.

View File

@@ -10,8 +10,8 @@ Designed for first-time users. Get set up, create your first PRD, and run your f
### Best Practices
Covers common workflows, strategic usage of commands, model configuration tips, and real-world usage patterns. Recommended for active users.
### Technical Capabilities
A detailed glossary of every root command and available capability — meant for power users and contributors.
### Technical Capabilities
A detailed glossary of every root command and available capability — including team collaboration with Hamster, MCP integration, and advanced workflows — meant for power users and contributors.
---

111
output.txt Normal file

File diff suppressed because one or more lines are too long