### Install BMad Method

Source: https://github.com/bmad-code-org/bmad-method/blob/main/README.md

Installs the BMad Method using npx. Follow the prompts for interactive setup. This is the recommended starting point for new projects.

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

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

### Ask BMad-Help with Project Context

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/tutorials/getting-started.md

Combine BMad-Help with a specific question to receive tailored guidance. This example asks for the starting point for a SaaS product idea.

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

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

### v6 Project Structure Example

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/how-to/upgrade-to-v6.md

This illustrates the unified structure of a BMad v6 project, highlighting the single installation folder `_bmad` and the output folder `_bmad-output`.

```text
your-project/
├── _bmad/               # Single installation folder
│   ├── _config/         # Your customizations
│   │   └── agents/      # Agent customization files
│   ├── core/            # Universal core framework
│   ├── bmm/             # BMad Method module
│   ├── bmb/             # BMad Builder
│   └── cis/             # Creative Intelligence Suite
└── _bmad-output/        # Output folder (was doc folder in v4)

```

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

### Ask BMad-Help for Initial Guidance

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/tutorials/getting-started.md

Use this command to ask BMad-Help for advice on what to do first in your project. It helps you get started quickly.

```bash
bmad-help what should I do first?
```

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

### Setup Commands (Bash)

Source: https://github.com/bmad-code-org/bmad-method/blob/main/src/bmm-skills/1-analysis/bmad-document-project/templates/index-template.md

Bash commands for setting up the project locally. This includes installing dependencies and configuring the environment.

```bash
# For single-part projects:
# Install dependencies
pip install -r requirements.txt
# Set up database (if applicable)
flask db upgrade

# For multi-part projects (example for 'core' part):
cd core
pip install -r requirements.txt
flask db upgrade
```

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

### Reproducible Bmad Install Command

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/how-to/install-bmad.md

Example command for installing Bmad with specific module versions pinned for reproducibility.

```bash
npx bmad-method install --yes --modules bmb,cis \
  --pin bmb=v1.7.0 --pin cis=v0.4.2 --tools claude-code
```

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

### Initial Setup and Update Calls

Source: https://github.com/bmad-code-org/bmad-method/blob/main/src/core-skills/bmad-brainstorming/assets/brain-selector.html

Calls initial setup functions for setting hints, theme icons, and updating the UI. These are typically executed once when the page loads.

```javascript
setHint();
setThemeIcon();
update();
})();
```

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

### Install BMad Method

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/tutorials/getting-started.md

Run this command in your project directory to install BMad Method. Use '@next' for the prerelease version.

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

```bash
npx bmad-method@next install
```

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

### BMad Help Skill Configuration Example

Source: https://github.com/bmad-code-org/bmad-method/blob/main/src/core-skills/bmad-help/SKILL.md

This is an example of the configuration file structure for the BMad Help skill, outlining its name and description.

```yaml
name: bmad-help
description: 'Analyzes current state and user query to answer BMad questions or recommend the next skill(s) to use. Use when user asks for help, bmad help, what to do next, or what to start with in BMad.'
```

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

### Install Multiple Custom Sources

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/how-to/install-custom-modules.md

Install custom modules from multiple sources, including local paths and Git URLs, by comma-separating them with the `--custom-source` flag.

```bash
--custom-source /path/one,https://github.com/org/repo,/path/two
```

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

### Simple Post-Install Notes

Source: https://github.com/bmad-code-org/bmad-method/blob/main/tools/installer/README.md

Always displayed after module configuration. Define static text for user guidance.

```yaml
post-install-notes: |
  Thank you for choosing the XYZ Cool Module
  For Support about this Module call 555-1212
```

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

### Mix Module Channels

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/how-to/install-bmad.md

Updates an existing installation to mix module channels, for example, installing one module on 'next' and another on 'stable'.

```bash
npx bmad-method install --yes --action update \
  --modules bmm,bmb,cis,gds \
  --next=bmb
```

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

### Technology Stack & Versions Example

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/explanation/project-context.md

Document the frameworks, languages, and tools your project uses, including specific versions. This helps AI agents understand the project's environment.

```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
```

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

### Create project-context.md file

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/how-to/project-context.md

Initializes the directory and file structure for the project context.

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

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

### Example Technical Research Topics

Source: https://github.com/bmad-code-org/bmad-method/blob/main/src/bmm-skills/1-analysis/research/bmad-technical-research/SKILL.md

Illustrative examples of technical research topics that can be provided by the user. These examples cover comparisons of technologies and architectural patterns.

```text
React vs Vue for large-scale applications
GraphQL vs REST API architectures
Serverless deployment options for Node.js
Or any other technical topic you have in mind...
```

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

### Install Enterprise Pin for Reproducible Builds

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/how-to/install-bmad.md

Installs specific versions of modules for byte-for-byte reproducible builds. Use '--yes' for non-interactive installation.

```bash
npx bmad-method install --yes \
  --modules bmm,bmb,cis \
  --pin bmb=v1.7.0 --pin cis=v0.2.0 \
  --tools claude-code
```

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

### Invoke Quick Dev with Intent

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/how-to/quick-fixes.md

Examples of how to trigger the Quick Dev process using various forms of intent, including direct descriptions, issue URLs, or file paths.

```text
run quick-dev — Fix the login validation bug that allows empty passwords.
```

```text
run quick-dev — fix https://github.com/org/repo/issues/42
```

```text
run quick-dev — implement the intent in _bmad-output/implementation-artifacts/my-intent.md
```

```text
I think the problem is in the auth middleware, it's not checking token expiry.
Let me look at it... yeah, src/auth/middleware.ts line 47 skips
the exp check entirely. run quick-dev
```

```text
run quick-dev
> What would you like to do?
Refactor UserService to use async/await instead of callbacks.
```

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

### Install Latest Stable Bmad Method

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/how-to/install-bmad.md

Installs the latest stable versions of specified modules and tools. Use '--yes' for non-interactive installation.

```bash
npx bmad-method install --yes --modules bmm,bmb,cis --tools claude-code
```

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

### Configure Module Settings During Install

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/how-to/install-bmad.md

Installs a module and sets specific configuration options non-interactively using the '--set' flag. This applies patches after the main installation.

```bash
npx bmad-method install --yes \
  --modules bmm \
  --tools claude-code \
  --set bmm.project_knowledge=research \
  --set bmm.user_skill_level=expert
```

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

### Install Bleeding Edge Version

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/how-to/install-bmad.md

Installs the latest development versions of modules from the main branch, including all next versions. Use '--yes' for non-interactive installation.

```bash
npx bmad-method install --yes --modules bmm,bmb --all-next --tools claude-code
```

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

### Install Official and Custom Modules

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/how-to/install-custom-modules.md

Install official modules (e.g., 'bmm') along with a custom module from a Git URL. This command also specifies the installation directory, tools, and automatically confirms prompts.

```bash
npx bmad-method install \
  --directory . \
  --modules bmm \
  --custom-source https://gitlab.com/myorg/my-module \
  --tools claude-code \
  --yes
```

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

### Solution With Solutioning

Source: https://github.com/bmad-code-org/bmad-method/blob/main/docs/explanation/why-solutioning-matters.md

Demonstrates how documenting architectural decisions ensures all agents follow a consistent approach, such as using GraphQL for all APIs, resulting in a unified implementation and straightforward integration.

```text
architecture workflow decides: "Use GraphQL for all APIs"
All agents follow architecture decisions
Result: Consistent implementation, no conflicts
```