Reference

Every command, option, file and setting, with exact syntax.

Pages in this section

• CLI overview

  How to run bmad-plus, the options every command shares, the installer languages, non-interactive use with --yes, and the exit codes you can rely on in scripts and CI.

• install

  Install BMAD+ agents, skills, instruction files and configuration into a project: every flag, what is written, how a re-run behaves, real output and the errors you can meet.

• update

  Move an installed project to a newer BMAD+ version with a plan, backups and a receipt you can restore from: flags, what is preserved, refusals, recovery and every message.

• uninstall

  Remove what BMAD+ owns from a project and keep your memory, settings, edited and unknown files: flags, exactly what is deleted, what stays, real output and the messages you can meet.

• doctor

  A read-only health report on an installation: manifest, ownership inventory, modified files, instruction files, runtimes. Flags, every check code, the JSON report, real output and exit codes.

• update-check

  Ask npm whether a newer BMAD+ release exists and whether your policy would let it apply, without changing anything: flags, statuses, reasons, the JSON fields, cache and offline behaviour.

• update-policy

  Show or set the project policy that decides whether BMAD+ looks for updates and whether any may apply without you: modes off, notify and auto, channel, range, prereleases, the file and the errors.

• autoconfig

  Bootstrap BMAD+ in an existing repository or an empty folder: it detects the stack, scores project health, recommends packs, installs them and seeds the project memory.

• scan

  Walk a directory tree, find your projects, detect their stack and activity, and index them in the global brain so BMAD+ knows your whole portfolio.

• bmad-plus memory

  Read the health of the project memory and of the global brain, and export the global brain to one Markdown file. Flags, what it reads and writes, output, exit codes and errors.

• bmad-plus mem

  Recall past decisions and events, journal what an agent did, reinforce a pattern with reward signals and tie lessons to accepted Nexus work. Flags, files, exit codes, output and errors.

• studio

  List the Dev Studio workflows and prepare a read-only context bundle for one of them, so your assistant can run it with the exact instructions that shipped in your project.

• bmad-plus intake

  Validate a pack questionnaire, plan the next questions, record answers with their status and render the brief a pack works from. Flags, exit codes, real output and errors.

• bmad-plus swarm

  Deal, brief, check, file and tally a swarm of sub-agents within a budget: panel, jury or fanout. Flags, run tree, approval at exit 2, honesty rules, real output and errors.

• nexus

  Durable task runs: a plan of tasks with disjoint write scopes, attempts you can recover after an interruption, independent verification, and a separate acceptance step.

• bmad-plus uat

  Reference for bmad-plus uat (alias recette): lint, build, serve, import, read, gate and order human acceptance recipes, with flags, exit codes and sample output.

• bmad-plus review

  Reference for bmad-plus review: seal a review scope, anchor findings on the code, derive a verdict from coverage, resume, compare and list rules, with flags and exit codes.

• assurance

  Build a security assurance case: claims backed only by checks that really ran, recorded in a hash-chained ledger, then verified at a commit. Shield tooling, exit codes and failure modes.

• ai-register

  Keep a register of the AI tools your project uses, their data, legal basis and transfers, and let a soft check warn about any AI integration found in the repository that the register misses.

• Configuration file

  Every key of _bmad/config.yaml: execution mode, the four checkpoints, the uat block and the swarm budget. Defaults, who reads each key, and what changing it does.

• Adapters

  The seven AI tools BMAD+ prepares: the file written for each, how a tool is detected, the shared AGENTS.md spine, and how installs and updates protect instructions you wrote yourself.

• Project layout

  Every folder and file BMAD+ creates in a project and on your machine, which command creates it, and whether it is yours to edit, BMAD+’s to manage, or state to leave alone.