feat(installer): add Codex CLI + Codex Web modes, generate AGENTS.md, inject npm scripts, and docs (#529)

This commit is contained in:
Jonathan Borgwing
2025-08-31 18:48:03 -04:00
committed by GitHub
parent 052e84dd4a
commit 05736fa069
5 changed files with 240 additions and 1 deletions

View File

@@ -243,3 +243,19 @@ BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. All rights reserved
[![Contributors](https://contrib.rocks/image?repo=bmadcode/bmad-method)](https://github.com/bmadcode/bmad-method/graphs/contributors)
<sub>Built with ❤️ for the AI-assisted development community</sub>
#### Codex (CLI & Web)
- Two modes are supported:
- Codex (local only): `npx bmad-method install -f -i codex -d .` — keeps `.bmad-core/` ignored via `.gitignore` for local development.
- Codex Web Enabled: `npx bmad-method install -f -i codex-web -d .` — ensures `.bmad-core/` is tracked (not ignored) so it can be committed for Codex Web.
- For Codex Web, commit both `.bmad-core/` and `AGENTS.md` to the repository.
- Codex CLI: run `codex` at your project root; reference agents naturally, e.g., “As dev, implement …”.
- Codex Web: open your repo in Codex and prompt the same way — it reads `AGENTS.md` automatically.
- Refresh after changes: rerun the appropriate install command (`codex` or `codex-web`) to regenerate the BMAD section inside `AGENTS.md`.
If a `package.json` exists in your project, the installer will add helpful scripts:
- `bmad:refresh``bmad-method install -f -i codex`
- `bmad:list``bmad-method list:agents`
- `bmad:validate``bmad-method validate`