mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
eat: enhance flattener tool with improved CLI integration and custom directory support (#372)
* feat(cli): move flatten command to installer and update docs Refactor the flatten command from tools/cli.js to tools/installer/bin/bmad.js for better integration. Add support for custom input directory and improve error handling. Update documentation in README.md and working-in-the-brownfield.md to reflect new command usage. Also clean up package-lock.json and add it to .gitignore. * chore: update gitignore and add package-lock.json for installer tool Remove package-lock.json from root gitignore since it's now needed for the installer tool Add package-lock.json with dependencies for the bmad-method installer --------- Co-authored-by: Devin Stagner <devin@blackstag.family>
This commit is contained in:
13
README.md
13
README.md
@@ -126,11 +126,18 @@ The BMad-Method includes a powerful codebase flattener tool designed to prepare
|
||||
|
||||
```bash
|
||||
# Basic usage - creates flattened-codebase.xml in current directory
|
||||
npm run flatten
|
||||
npx bmad-method flatten
|
||||
|
||||
# Specify custom input directory
|
||||
npx bmad-method flatten --input /path/to/source/directory
|
||||
npx bmad-method flatten -i /path/to/source/directory
|
||||
|
||||
# Specify custom output file
|
||||
npm run flatten -- --output my-project.xml
|
||||
npm run flatten -- -o /path/to/output/codebase.xml
|
||||
npx bmad-method flatten --output my-project.xml
|
||||
npx bmad-method flatten -o /path/to/output/codebase.xml
|
||||
|
||||
# Combine input and output options
|
||||
npx bmad-method flatten --input /path/to/source --output /path/to/output/codebase.xml
|
||||
```
|
||||
|
||||
### Example Output
|
||||
|
||||
Reference in New Issue
Block a user