docs/start/install-bmad.md
Use npx bmad-method install to install BMad in a project, connect it to your
AI coding tool, and update it later.
:::note[Prerequisites]
npx bmad-method install --list-tools.uv, including
bmad-build and bmad-build-auto. If uv is missing, the installer warns
you but still completes the installation.:::
In a terminal, go to the project where you want to install BMad. The installer uses the current directory unless you choose a different destination.
npx bmad-method install
Follow the prompts. The choices can change as modules and tool integrations change, but the installer guides you through the available modules, configuration, and supported AI coding tools.
If the installer reports an error or warning, follow the action it gives you.
A missing-uv warning does not stop the installation, but skills that require
uv will not work until you install it.
When the installation finishes, the installer displays BMAD is ready to use! and the path where it installed BMad. It also reports any warnings that still need attention.
Open your selected AI coding tool from the project directory and invoke the
bmad-help skill. Ask it what to do next. If the tool recognizes and runs the
skill, the integration is ready.
From the project that contains the _bmad directory, run:
npx bmad-method install
The installer detects the existing installation and offers the update or
modification paths that apply to it. Choose an update to refresh the existing
setup, or choose modification when you need to change modules, tools, or
configuration. Follow any additional prompts the installer displays. Coming
from an earlier BMad version, the installer also warns about stale bmad-*
entries left in legacy command directories; remove them so your tool does not
show duplicate commands.
Review the success summary, reopen your AI coding tool if needed, and invoke
bmad-help again.
To install prerelease core and BMM and apply prerelease selection to external modules chosen in that run, use:
npx bmad-method@next install
To update a prerelease installation, rerun the same command. Prerelease builds change more frequently and can include unfinished changes, so use the stable command for ordinary project work.
For a typical fresh headless install of BMM configured for Claude Code, run:
npx bmad-method install --yes --modules bmm --tools claude-code
Use npx bmad-method install --help to see the current automation flags and
npx bmad-method install --list-tools to find valid tool IDs. If your
automation uses @next or an explicit package version, use that same tag or
version when checking the help and running the installer.
BMad's skills are installed in the skill directories used by each AI tool you
selected. The project's _bmad directory contains shared configuration and
supporting scripts used by those skills. When installation finishes, the
installer reports the configured tools and any warnings that still need
attention.