Reference
Flags accepted by every Broom command, including JSON output.
These flags work with every command, before or after the command name.
| Flag | Description |
|---|---|
--json | Print exactly one JSON document on stdout. Progress and warnings go to stderr. |
--verbose | Show reasons, locations and diagnostics. |
-q, --quiet | Only essential output. Cannot be combined with --verbose. |
--no-color | Disable colors (NO_COLOR is honored too). |
--cwd <path> | Run against another project directory. |
-v, --version | Print the version. |
-h, --help | Show help (also broom <command> --help). |
Successful runs print:
{ "ok": true, "command": "env", "version": "0.1.0", "root": "/abs/path", "data": {} }Failures print an error object and exit with a non-zero code:
{ "ok": false, "command": "recap", "version": "0.1.0", "error": { "code": "…", "message": "…", "hint": "…" }}hint is optional. The data shape of each command is defined by the *Report types in src/modules/*/types.ts.
Colors are disabled with --no-color, the NO_COLOR environment variable, or "output": { "color": false } in the configuration.
Found a problem in these docs? Open an issue on GitHub.