Skip to content

Commit 6d1e8b0

Browse files
authored
Align CLI docs with current help output for run/compile/logs/remove/fix/validate (#27622)
1 parent 05db80f commit 6d1e8b0

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

  • docs/src/content/docs/setup

docs/src/content/docs/setup/cli.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ gh aw fix my-workflow --write # Fix specific workflow
237237
gh aw fix --list-codemods # List available codemods
238238
```
239239

240-
**Options:** `--write`, `--list-codemods`
240+
**Options:** `--dir/-d`, `--list-codemods`, `--write`
241241

242242
Available codemods include:
243243

@@ -263,7 +263,7 @@ gh aw compile --dependabot # Generate dependency manifests
263263
gh aw compile --purge # Remove orphaned .lock.yml files
264264
```
265265

266-
**Options:** `--validate`, `--strict`, `--fix`, `--zizmor`, `--dependabot`, `--json`, `--no-emit`, `--watch`, `--purge`, `--stats`, `--approve`
266+
**Options:** `--action-mode`, `--action-tag`, `--actionlint`, `--actions-repo`, `--allow-action-refs`, `--approve`, `--dependabot`, `--dir/-d`, `--engine/-e`, `--fail-fast`, `--fix`, `--force`, `--force-refresh-action-pins`, `--json/-j`, `--logical-repo`, `--no-check-update`, `--no-emit`, `--poutine`, `--purge`, `--refresh-stop-time`, `--runner-guard`, `--schedule-seed`, `--stats`, `--strict`, `--trial`, `--validate`, `--validate-images`, `--watch/-w`, `--zizmor`
267267

268268
**`--approve` flag:** When compiling a workflow that already has a lock file, the compiler enforces *safe update mode* — any newly added secrets or custom actions not present in the previous manifest require explicit approval. Pass `--approve` to accept these changes and regenerate the manifest baseline. On first compile (no existing lock file), enforcement is skipped automatically and `--approve` is not needed.
269269

@@ -292,7 +292,7 @@ gh aw validate --dir custom/workflows # Validate from custom directory
292292
gh aw validate --engine copilot # Override AI engine
293293
```
294294

295-
**Options:** `--engine/-e`, `--dir/-d`, `--strict`, `--json/-j`, `--fail-fast`, `--stats`, `--no-check-update`
295+
**Options:** `--allow-action-refs`, `--dir/-d`, `--engine/-e`, `--fail-fast`, `--json/-j`, `--no-check-update`, `--stats`, `--strict`, `--validate-images`
296296

297297
All linters (`zizmor`, `actionlint`, `poutine`), `--validate`, and `--no-emit` are always-on defaults and cannot be disabled. Accepts the same workflow ID format as `compile`.
298298

@@ -320,7 +320,7 @@ Execute workflows immediately in GitHub Actions. Displays workflow URL for track
320320
```bash wrap
321321
gh aw run workflow # Run workflow
322322
gh aw run workflow1 workflow2 # Run multiple workflows
323-
gh aw run workflow --repeat 3 # Repeat 3 times
323+
gh aw run workflow --repeat 3 # Run 4 times total (1 initial + 3 repeats)
324324
gh aw run workflow --push # Auto-commit, push, and dispatch workflow
325325
gh aw run workflow --push --ref main # Push to specific branch
326326
gh aw run workflow --json # Output triggered workflow results as JSON
@@ -400,7 +400,7 @@ gh aw logs --train # Train on last 10 runs
400400
gh aw logs my-workflow --train -c 50 # Train on up to 50 runs of a specific workflow
401401
```
402402

403-
**Options:** `-c`, `--count`, `--last`, `-e`, `--engine`, `--start-date`, `--end-date`, `--ref`, `--parse`, `--json`, `--train`, `--repo`, `--firewall`, `--no-firewall`, `--safe-output`, `--filtered-integrity`, `--after-run-id`, `--before-run-id`, `--no-staged`, `--tool-graph`, `--timeout`
403+
**Options:** `--after-run-id`, `--artifacts`, `--before-run-id`, `--count/-c`, `--end-date`, `--engine/-e`, `--filtered-integrity`, `--firewall`, `--format`, `--json/-j`, `--last`, `--no-firewall`, `--no-staged`, `--output/-o`, `--parse`, `--ref`, `--repo/-r`, `--safe-output`, `--start-date`, `--summary-file`, `--timeout`, `--tool-graph`, `--train`
404404

405405
#### `audit`
406406

@@ -539,7 +539,7 @@ gh aw remove test- # Remove all workflows starting with 't
539539
gh aw remove my-workflow --keep-orphans # Remove but keep orphaned include files
540540
```
541541

542-
**Options:** `--keep-orphans`
542+
**Options:** `--dir/-d`, `--keep-orphans`
543543

544544
#### `update`
545545

0 commit comments

Comments
 (0)