Skip to content

Commit 06c8e7e

Browse files
docs(cli): document --path flag for gh aw list and clarify --dir vs --path distinction (#23124)
1 parent 4cf9de0 commit 06c8e7e

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

  • docs/src/content/docs/setup

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -334,12 +334,15 @@ gh aw list # List all workflows
334334
gh aw list ci- # Filter by pattern (case-insensitive)
335335
gh aw list --json # Output in JSON format
336336
gh aw list --label automation # Filter by label
337-
gh aw list --dir custom/workflows # List from custom directory
337+
gh aw list --dir custom/workflows # List from a local custom directory
338+
gh aw list --repo owner/repo --path .github/workflows # List from a remote repository
338339
```
339340

340-
**Options:** `--json`, `--label`, `--dir/-d`
341+
**Options:** `--json`, `--label`, `--dir/-d`, `--path`, `--repo`
341342

342-
The `--dir` flag overrides the local workflow directory. It applies only when `--repo` is not set, consistent with other commands such as `validate`, `fix`, and `add`.
343+
Two flags control the workflow directory location, with different purposes:
344+
- `--dir` (`-d`): overrides the **local** workflow directory. Applies only when `--repo` is not set.
345+
- `--path`: specifies the workflow directory path in a **remote** repository. Use together with `--repo`.
343346

344347
Fast enumeration without GitHub API queries. For detailed status including enabled/disabled state and run information, use `status` instead.
345348

0 commit comments

Comments
 (0)