Address review comments

This commit is contained in:
Akhilesh Tyagi 2026-03-26 19:34:05 +05:30
parent 5e7d0bc178
commit 0bd2351612
No known key found for this signature in database
GPG Key ID: 9321F0F40DBA6BF4
1 changed files with 14 additions and 1 deletions

View File

@ -37,7 +37,19 @@ Requires [Node.js](https://nodejs.org) v20+ and `npx` (included with npm).
| `--user-name <name>` | Name for agents to use | System username | | `--user-name <name>` | Name for agents to use | System username |
| `--communication-language <lang>` | Agent communication language | English | | `--communication-language <lang>` | Agent communication language | English |
| `--document-output-language <lang>` | Document output language | English | | `--document-output-language <lang>` | Document output language | English |
| `--output-folder <path>` | Output folder path | _bmad-output | | `--output-folder <path>` | Output folder path (see resolution rules below) | `_bmad-output` |
#### Output Folder Path Resolution
The value passed to `--output-folder` (or entered interactively) is resolved according to these rules:
| Input type | Example | Resolved as |
|------------|---------|-------------|
| Relative path (default) | `_bmad-output` | `<project-root>/_bmad-output` |
| Relative path with traversal | `../../shared-outputs` | Normalized absolute path — e.g. `/Users/me/shared-outputs` |
| Absolute path | `/Users/me/shared-outputs` | Used as-is — project root is **not** prepended |
The resolved path is what agents and workflows use at runtime when writing output files. Using an absolute path or a traversal-based relative path lets you direct all generated artifacts to a directory outside your project tree — useful for shared or monorepo setups.
### Other Options ### Other Options
@ -141,6 +153,7 @@ Invalid values will either:
:::tip[Best Practices] :::tip[Best Practices]
- Use absolute paths for `--directory` to avoid ambiguity - Use absolute paths for `--directory` to avoid ambiguity
- Use an absolute path for `--output-folder` when you want artifacts written outside the project tree (e.g. a shared monorepo outputs directory)
- Test flags locally before using in CI/CD pipelines - Test flags locally before using in CI/CD pipelines
- Combine with `-y` for truly unattended installations - Combine with `-y` for truly unattended installations
- Use `--debug` if you encounter issues during installation - Use `--debug` if you encounter issues during installation