Skip to content

Commit ad9ec85

Browse files
jingle2008claude
andcommitted
docs: surface -d/-n shorthand flags in README and USER_MANUAL
The 7f73f60 commit added -d for --debug and -n for --dry-run (on the six mutation subcommands), but the docs still showed only the long forms. Update three spots: - README.md persistent-flags table: --debug row now reads `--debug, -d` - README.md mutation paragraph: `--dry-run` → `--dry-run / -n` - docs/USER_MANUAL.md persistent-flags table: same as README Matches the existing convention used for `--category, -c` and `--filter, -f`. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 83f8ce8 commit ad9ec85

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ toolkit --help # all global flags
124124
| `--metadata-file` | `~/.config/toolkit/metadata.yaml` | Optional additional metadata file |
125125
| `--kubeconfig` | `~/.kube/config` | Path to kubeconfig file |
126126
| `--log-file` | `toolkit.log` | Path to log file |
127-
| `--debug` | `false` | Enable debug logging |
127+
| `--debug, -d` | `false` | Enable debug logging |
128128
| `--log-format` | `console` | Log format: `console`, `json`, or `slog` |
129129
| `--log-level` | | Minimum log level: `debug`, `info`, `warn`, `error` (empty uses `--debug` flag) |
130130
| `--mutation-env-override-allowed` | `false` | Allow MCP mutation tools to override the startup env per call (off by default for safety) |
@@ -179,7 +179,7 @@ toolkit config --validate # run config.Validate(); exit non-zero on fail
179179

180180
### Cluster mutations
181181

182-
Maintenance operations the TUI exposes via keyboard shortcuts are also available as scriptable subcommands. All mutations support `--dry-run` (preview the action) and `--yes` / `-y` (skip the interactive prompt). Each call writes a JSON line to the audit log.
182+
Maintenance operations the TUI exposes via keyboard shortcuts are also available as scriptable subcommands. All mutations support `--dry-run` / `-n` (preview the action) and `--yes` / `-y` (skip the interactive prompt). Each call writes a JSON line to the audit log.
183183

184184
| Command | Effect |
185185
| ------- | ------ |

docs/USER_MANUAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ All flags can be set in the config file or passed directly on the command line.
121121
| `metadata-file` | `--metadata-file` | `~/.config/toolkit/metadata.yaml` | No | Optional extra metadata file |
122122
| `config` | `--config` | `~/.config/toolkit/config.yaml` | No | Path to the config file itself |
123123
| `log-file` | `--log-file` | `toolkit.log` | No | Log output path |
124-
| `debug` | `--debug` | `false` | No | Enable debug-level logging |
124+
| `debug` | `-d / --debug` | `false` | No | Enable debug-level logging |
125125
| `log-format` | `--log-format` | `console` | No | Log format: `console`, `json`, or `slog` |
126126
| `log-level` | `--log-level` | `""` | No | Minimum log level: `debug` `info` `warn` `error` |
127127

0 commit comments

Comments
 (0)