From c53f50bc0f5b2e8282c6cdf510aeee5d480e425e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 22 Jan 2026 12:25:34 +0000 Subject: [PATCH] docs: document gh aw list command Add documentation for the new `gh aw list` command that was merged in PR #11218. This command provides fast workflow enumeration without querying GitHub API for workflow state. Changes: - Add gh aw list to "Most Common Commands" table - Add complete documentation section under "Monitoring" - Include usage examples and options - Clarify differences from gh aw status command Co-Authored-By: Claude Sonnet 4.5 --- docs/src/content/docs/setup/cli.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/src/content/docs/setup/cli.md b/docs/src/content/docs/setup/cli.md index fb41e133e18..2f2acb1f0a7 100644 --- a/docs/src/content/docs/setup/cli.md +++ b/docs/src/content/docs/setup/cli.md @@ -19,6 +19,7 @@ The `gh aw` CLI extension enables developers to create, manage, and execute AI-p |---------|-------------|---------| | **`gh aw init`** | Set up your repository for agentic workflows | [→ Documentation](#init) | | **`gh aw add (workflow)`** | Add workflows from The Agentics collection or other repositories | [→ Documentation](#add) | +| **`gh aw list`** | Quick listing of all workflows without status checks | [→ Documentation](#list) | | **`gh aw status`** | Check current state of all workflows | [→ Documentation](#status) | | **`gh aw compile`** | Convert markdown to GitHub Actions YAML | [→ Documentation](#compile) | | **`gh aw run (workflow)`** | Execute workflows immediately in GitHub Actions | [→ Documentation](#run) | @@ -273,6 +274,21 @@ When `--push` is not used, warnings are displayed for missing or outdated lock f ### Monitoring +#### `list` + +List workflows with basic information (name, engine, compilation status) without checking GitHub Actions state. Fast enumeration for discovering available workflows. + +```bash wrap +gh aw list # List all workflows +gh aw list ci- # Filter by pattern (case-insensitive) +gh aw list --json # Output in JSON format +gh aw list --label automation # Filter by label +``` + +**Options:** `--json`, `--label` + +Unlike `status`, this command does not query GitHub API for workflow state or execution history. Use this for quick discovery and filtering. For detailed status including enabled/disabled state and latest run information, use `status` instead. + #### `status` List workflows with state, enabled/disabled status, schedules, and labels. With `--ref`, includes latest run status.