### Interact with BMad-Help Agent

Source: https://docs.bmad-method.org/tutorials/getting-started

BMad-Help is an intelligent guide that assists you throughout the development process. You can invoke it directly for general guidance or combine it with a question for context-aware recommendations. It inspects your project, suggests next steps, and answers questions about starting points and available options.

```bash
/bmad-help
```

```bash
bmad-help I have an idea for a SaaS product, I already know all the features I want. where do I get started?
```

--------------------------------

### Start BMad Create Product Brief Workflow

Source: https://docs.bmad-method.org/tutorials/getting-started

This command initiates the 'create-product-brief' workflow, also part of the optional Phase 1: Analysis. This workflow helps generate a foundational document for your project.

```bash
/bmad-create-product-brief
```

--------------------------------

### Interactive Sharding Process Example

Source: https://docs.bmad-method.org/how-to/shard-large-documents

This snippet demonstrates the interactive command-line prompts and user responses during the document sharding process. It shows how the tool prompts for the document to shard and the destination, then confirms completion.

```bash
Agent: Which document would you like to shard?
User: docs/PRD.md


Agent: Default destination: docs/prd/
       Accept default? [y/n]
User: y


Agent: Sharding PRD.md...
       ✓ Created 12 section files
       ✓ Generated index.md
       ✓ Complete!
```

--------------------------------

### Start BMad Brainstorming Workflow

Source: https://docs.bmad-method.org/tutorials/getting-started

This command initiates the brainstorming workflow, which is part of the optional Phase 1: Analysis. This workflow guides you through ideation to help define your project's initial concepts.

```bash
/bmad-brainstorming
```

--------------------------------

### Start BMad Research Workflow

Source: https://docs.bmad-method.org/tutorials/getting-started

This command initiates the research workflow, part of the optional Phase 1: Analysis. It assists in conducting market and technical research to inform your project's direction.

```bash
/bmad-research
```

--------------------------------

### Install BMad-Method Modules

Source: https://docs.bmad-method.org/reference/commands

The installation command initializes the BMad-Method environment and generates the necessary skill files based on selected modules. This command should be re-run if skills are missing or if module configurations have changed.

```bash
npx bmad-method install
```

--------------------------------

### Run BMad Workflows

Source: https://docs.bmad-method.org/tutorials/getting-started

Workflows are invoked using specific skills within your AI IDE. For example, '/bmad-create-prd' starts the Product Requirements Document workflow. Running a workflow skill automatically loads the necessary agent, eliminating the need for separate agent invocation.

```bash
/bmad-create-prd
```

--------------------------------

### Verify BMad Installation with bmad-help

Source: https://docs.bmad-method.org//llms-full.txt

Use the 'bmad-help' command to confirm your BMad installation is working correctly. It will display available modules, confirm installation status, and suggest next steps. You can also ask it specific questions about your project or available options.

```bash
bmad-help
```

```bash
bmad-help I just installed, what should I do first?
```

```bash
bmad-help What are my options for a SaaS project?
```

--------------------------------

### Installing Bleeding-Edge BMad Method

Source: https://docs.bmad-method.org//llms-full.txt

For the latest, potentially unstable version of BMad Method, you can install directly from the main branch on GitHub using the command `npx github:bmad-code-org/BMAD-METHOD install`. This is useful for testing the newest features.

```bash
npx github:bmad-code-org/BMAD-METHOD install
```

--------------------------------

### Generate Project Context File

Source: https://docs.bmad-method.org/tutorials/getting-started

This command generates a 'project-context.md' file, which documents your technical preferences and implementation rules. This file ensures consistency across all AI agents and workflows throughout the project lifecycle. It can be created manually or generated after the architecture phase.

```bash
/bmad-generate-project-context
```

--------------------------------

### Install and Configure BMad Method

Source: https://docs.bmad-method.org//llms-full.txt

Commands for installing, updating, and customizing BMad Method environments. These commands support various flags for directory management, module selection, and automation.

```bash
npx bmad-method install \
  --directory "${GITHUB_WORKSPACE}" \
  --modules bmm \
  --tools claude-code \
  --user-name "CI Bot" \
  --communication-language English \
  --document-output-language English \
  --output-folder _bmad-output \
  --yes
```

```bash
npx bmad-method install \
  --directory ~/projects/myapp \
  --action update \
  --modules bmm,bmb,custom-module
```

```bash
npx bmad-method install \
  --directory ~/projects/myapp \
  --action quick-update
```

```bash
npx bmad-method install \
  --directory ~/projects/myapp \
  --modules bmm \
  --custom-content ~/my-custom-module,~/another-module \
  --tools claude-code
```

--------------------------------

### Quick Update for BMad Method Installation

Source: https://docs.bmad-method.org/how-to/non-interactive-installation

This command performs a quick update of an existing BMad Method installation, preserving existing settings. It only requires specifying the installation directory and the `quick-update` action.

```bash
npx bmad-method install \
  --directory ~/projects/myapp \
  --action quick-update

```

--------------------------------

### BMad Method Installation with Custom Content

Source: https://docs.bmad-method.org/how-to/non-interactive-installation

This command installs BMad Method, including custom modules. It specifies the installation directory, the core module (`bmm`), paths to custom content modules, and the desired tool/IDE.

```bash
npx bmad-method install \
  --directory ~/projects/myapp \
  --modules bmm \
  --custom-content ~/my-custom-module,~/another-module \
  --tools claude-code

```

--------------------------------

### Invoke BMad Agents Directly

Source: https://docs.bmad-method.org/tutorials/getting-started

You can invoke specific BMad agents directly for general conversation or tasks outside of a formal workflow. For instance, '/bmad-pm' invokes the Project Manager agent. This allows for more flexible interaction with the AI capabilities.

```bash
/bmad-pm
```

--------------------------------

### Create project-context.md file using Bash

Source: https://docs.bmad-method.org//llms-full.txt

This bash command demonstrates how to create the `project-context.md` file and its parent directory `_bmad-output` in the project root. This file is essential for guiding AI agents with project-specific rules and configurations.

```bash
# In your project root
mkdir -p _bmad-output
touch _bmad-output/project-context.md
```

--------------------------------

### Using BMad-Help Command-Line Tool

Source: https://docs.bmad-method.org//llms-full.txt

The BMad-Help tool can be invoked with just a skill name or combined with a natural language query to receive specific recommendations and process steps. It provides guidance on what's recommended, the first required task, and the overall process.

```bash
/bmad-help
/bmad-help I have a SaaS idea and know all the features. Where do I start?
/bmad-help What are my options for UX design?
/bmad-help I'm stuck on the PRD workflow
/bmad-help Show me what's been done so far
```

--------------------------------

### BMad Non-Interactive Installation

Source: https://docs.bmad-method.org/how-to/non-interactive-installation

Install BMad non-interactively using command-line flags. This method is ideal for automated deployments, CI/CD pipelines, scripted installations, and batch installations across multiple projects.

```APIDOC
## POST /websites/bmad-method/install

### Description
Installs BMad non-interactively using command-line flags. This is useful for automated deployments, CI/CD pipelines, scripted installations, and batch installations across multiple projects.

### Method
POST

### Endpoint
/websites/bmad-method/install

### Parameters
#### Query Parameters
- **directory** (string) - Required - Installation directory path.
- **modules** (string) - Required - Comma-separated module IDs (e.g., `bmm,bmb`).
- **tools** (string) - Optional - Comma-separated tool/IDE IDs (use `none` to skip).
- **custom-content** (string) - Optional - Comma-separated paths to custom modules.
- **action** (string) - Optional - Action for existing installations: `install` (default), `update`, `quick-update`, or `compile-agents`.
- **user-name** (string) - Optional - Name for agents to use. Defaults to system username.
- **communication-language** (string) - Optional - Agent communication language. Defaults to English.
- **document-output-language** (string) - Optional - Document output language. Defaults to English.
- **output-folder** (string) - Optional - Output folder path. Defaults to `_bmad-output`.
- **yes** (boolean) - Optional - Accept all defaults and skip prompts.
- **debug** (boolean) - Optional - Enable debug output for manifest generation.

### Request Example
```bash
npx bmad-method install \
  --directory "${GITHUB_WORKSPACE}" \
  --modules bmm \
  --tools claude-code \
  --user-name "CI Bot" \
  --communication-language English \
  --document-output-language English \
  --output-folder _bmad-output \
  --yes
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the installation.
- **message** (string) - A confirmation message of the installation.

#### Response Example
```json
{
  "status": "success",
  "message": "BMad installed successfully."
}
```

### Error Handling
- **Directory** - Must be a valid path with write permissions. Invalid values will show an error and exit.
- **Modules** - Warns about invalid module IDs but won’t fail.
- **Tools** - Warns about invalid tool IDs but won’t fail.
- **Custom Content** - Each path must contain a valid `module.yaml` file. Invalid paths will be skipped.
- **Action** - Must be one of: `install`, `update`, `quick-update`, `compile-agents`. Invalid values will show an error and exit.
- Other invalid values may show a warning and skip, or fall back to interactive prompts for missing required values.
```

--------------------------------

### Manage Project Context Files

Source: https://docs.bmad-method.org//llms-full.txt

Commands and templates for creating and generating project-context.md files. These files define technical preferences and rules for AI agents working on the project.

```bash
mkdir -p _bmad-output
touch _bmad-output/project-context.md
```

```markdown
---
project_name: 'MyProject'
user_name: 'YourName'
date: '2026-02-15'
sections_completed: ['technology_stack', 'critical_rules']
---

# Project Context for AI Agents

## Technology Stack & Versions

- Node.js 20.x, TypeScript 5.3, React 18.2
- State: Zustand
- Testing: Vitest, Playwright
- Styling: Tailwind CSS

## Critical Implementation Rules

**TypeScript:**
- Strict mode enabled, no `any` types
- Use `interface` for public APIs, `type` for unions

**Code Organization:**
- Components in `/src/components/` with co-located tests
- API calls use `apiClient` singleton — never fetch directly

**Testing:**
- Unit tests focus on business logic
- Integration tests use MSW for API mocking
```

```bash
bmad-generate-project-context
```

--------------------------------

### Update Existing BMad Method Installation

Source: https://docs.bmad-method.org/how-to/non-interactive-installation

This command updates an existing BMad Method installation. It specifies the installation directory and the action to perform (`update`), along with a comma-separated list of modules to include in the update.

```bash
npx bmad-method install \
  --directory ~/projects/myapp \
  --action update \
  --modules bmm,bmb,custom-module

```

--------------------------------

### CI/CD Pipeline Installation with BMad Method

Source: https://docs.bmad-method.org/how-to/non-interactive-installation

This bash script demonstrates a fully non-interactive installation suitable for CI/CD pipelines. It specifies the installation directory, modules, tools, user name, communication languages, output folder, and accepts all defaults with the `--yes` flag.

```bash
#!/bin/bash
npx bmad-method install \
  --directory "${GITHUB_WORKSPACE}" \
  --modules bmm \
  --tools claude-code \
  --user-name "CI Bot" \
  --communication-language English \
  --document-output-language English \
  --output-folder _bmad-output \
  --yes

```

--------------------------------

### Define Technology Stack and Versions in Markdown

Source: https://docs.bmad-method.org//llms-full.txt

This markdown snippet demonstrates how to document the technology stack and specific versions used within a project. It's crucial for AI agents to understand the project's environment for consistent development.

```markdown
## Technology Stack & Versions

- Node.js 20.x, TypeScript 5.3, React 18.2
- State: Zustand (not Redux)
- Testing: Vitest, Playwright, MSW
- Styling: Tailwind CSS with custom design tokens
```