update docs
This commit is contained in:
@@ -17,6 +17,15 @@ This document provides a detailed reference for interacting with Taskmaster, cov
|
||||
|
||||
### 1. Initialize Project (`init`)
|
||||
|
||||
* **Brand Rules Option:**
|
||||
* `--rules <brands>` or `-r <brands>`: Comma-separated list of brand rule sets to apply at initialization (e.g., `cursor,windsurf,roo`).
|
||||
* Example: `task-master init --rules cursor,windsurf`
|
||||
* Example: `task-master init -r roo`
|
||||
* **What happens:**
|
||||
* For each brand, creates the appropriate rules directory (e.g., `.roo/rules`) and MCP config (e.g., `.roo/mcp.json`).
|
||||
* If not specified, only Cursor rules are initialized by default.
|
||||
|
||||
|
||||
* **MCP Tool:** `initialize_project`
|
||||
* **CLI Command:** `task-master init [options]`
|
||||
* **Description:** `Set up the basic Taskmaster file structure and configuration in the current directory for a new project.`
|
||||
@@ -84,6 +93,18 @@ This document provides a detailed reference for interacting with Taskmaster, cov
|
||||
|
||||
---
|
||||
|
||||
### Add or Remove Brand Rules After Initialization
|
||||
|
||||
* **CLI Command:**
|
||||
* `task-master rules add <brands>`: Add one or more brand rule sets to your project (e.g., `task-master rules add windsurf,roo`).
|
||||
* `task-master rules remove <brands>`: Remove one or more brand rule sets (e.g., `task-master rules remove windsurf`).
|
||||
* **What happens:**
|
||||
* Adding rules creates the brand rules directory (e.g., `.roo/rules`) and MCP config.
|
||||
* Removing rules deletes the brand rules directory and associated MCP config.
|
||||
* You can use multiple comma-separated brands in a single command.
|
||||
|
||||
---
|
||||
|
||||
## Task Listing & Viewing
|
||||
|
||||
### 3. Get Tasks (`get_tasks`)
|
||||
|
||||
16
README.md
16
README.md
@@ -102,6 +102,22 @@ task-master init --rules cursor,windsurf
|
||||
task-master parse-prd your-prd.txt
|
||||
|
||||
# Add or remove brand rules after initialization
|
||||
|
||||
You can add or remove brand rules at any time after project initialization:
|
||||
|
||||
```
|
||||
task-master rules add windsurf,roo
|
||||
# Adds the specified brand rule sets (e.g., .windsurf/rules, .roo/rules) to your project.
|
||||
# Also sets up the corresponding MCP configuration in the brand directory.
|
||||
|
||||
task-master rules remove windsurf
|
||||
# Removes the specified brand rule sets and their MCP config from your project.
|
||||
```
|
||||
|
||||
- Adding rules creates the brand rules directory (e.g., `.roo/rules`) and copies/initializes the brand's rules.
|
||||
- Removing rules deletes the brand rules directory and associated MCP config.
|
||||
- You can use multiple comma-separated brands in a single command.
|
||||
|
||||
task-master rules add windsurf,roo
|
||||
task-master rules remove windsurf
|
||||
|
||||
|
||||
@@ -17,6 +17,15 @@ This document provides a detailed reference for interacting with Taskmaster, cov
|
||||
|
||||
### 1. Initialize Project (`init`)
|
||||
|
||||
* **Brand Rules Option:**
|
||||
* `--rules <brands>` or `-r <brands>`: Comma-separated list of brand rule sets to apply at initialization (e.g., `cursor,windsurf,roo`).
|
||||
* Example: `task-master init --rules cursor,windsurf`
|
||||
* Example: `task-master init -r roo`
|
||||
* **What happens:**
|
||||
* For each brand, creates the appropriate rules directory (e.g., `.roo/rules`) and MCP config (e.g., `.roo/mcp.json`).
|
||||
* If not specified, only Cursor rules are initialized by default.
|
||||
|
||||
|
||||
* **MCP Tool:** `initialize_project`
|
||||
* **CLI Command:** `task-master init [options]`
|
||||
* **Description:** `Set up the basic Taskmaster file structure and configuration in the current directory for a new project.`
|
||||
@@ -84,6 +93,18 @@ This document provides a detailed reference for interacting with Taskmaster, cov
|
||||
|
||||
---
|
||||
|
||||
### Add or Remove Brand Rules After Initialization
|
||||
|
||||
* **CLI Command:**
|
||||
* `task-master rules add <brands>`: Add one or more brand rule sets to your project (e.g., `task-master rules add windsurf,roo`).
|
||||
* `task-master rules remove <brands>`: Remove one or more brand rule sets (e.g., `task-master rules remove windsurf`).
|
||||
* **What happens:**
|
||||
* Adding rules creates the brand rules directory (e.g., `.roo/rules`) and MCP config.
|
||||
* Removing rules deletes the brand rules directory and associated MCP config.
|
||||
* You can use multiple comma-separated brands in a single command.
|
||||
|
||||
---
|
||||
|
||||
## Task Listing & Viewing
|
||||
|
||||
### 3. Get Tasks (`get_tasks`)
|
||||
|
||||
Reference in New Issue
Block a user