Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/content/docs/examples/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Provide findings based on the requested depth level.

Via CLI:
```bash
gh aw run workflow-name
gh aw run workflow
```

Via GitHub Actions UI:
Expand Down
6 changes: 3 additions & 3 deletions docs/src/content/docs/guides/dispatchops.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ The `gh aw run` command provides a faster way to trigger workflows from the comm
### Basic Usage

```bash
gh aw run workflow-name
gh aw run workflow
```

The command:
Expand Down Expand Up @@ -169,7 +169,7 @@ gh aw run research --ref feature-branch
Execute workflows from other repositories:

```bash
gh aw run workflow-name --repo owner/repository
gh aw run workflow --repo owner/repository
```

### Verbose Output
Expand Down Expand Up @@ -316,7 +316,7 @@ The workflow runs with your branch's code and state. Safe outputs (issues, PRs,

## Troubleshooting

**Workflow not listed in GitHub UI:** Verify `workflow_dispatch:` exists in the `on:` section, compile the workflow (`gh aw compile workflow-name`), and push both `.md` and `.lock.yml` files. The Actions page may need a refresh.
**Workflow not listed in GitHub UI:** Verify `workflow_dispatch:` exists in the `on:` section, compile the workflow (`gh aw compile workflow`), and push both `.md` and `.lock.yml` files. The Actions page may need a refresh.

**"Workflow not found" error:** Use the filename without `.md` extension (`research` not `research.md`). Ensure the workflow exists in `.github/workflows/` and has been compiled.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/guides/web-search.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ mcp-servers:
allowed: ["search", "search_news"]
```

Test your configuration with `gh aw mcp inspect <workflow-name>`.
Test your configuration with `gh aw mcp inspect <workflow>`.

## Tool Discovery

Expand Down
20 changes: 10 additions & 10 deletions docs/src/content/docs/setup/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,14 +165,14 @@ gh auth login --hostname github.enterprise.com

# Use gh aw commands normally
gh aw status
gh aw logs workflow-name
gh aw logs workflow
```

When using the `--repo` flag, you can specify the enterprise host:

```bash wrap
gh aw logs workflow-name --repo github.enterprise.com/owner/repo
gh aw run workflow-name --repo github.enterprise.com/owner/repo
gh aw logs workflow --repo github.enterprise.com/owner/repo
gh aw run workflow --repo github.enterprise.com/owner/repo
```

## Global Options
Expand Down Expand Up @@ -354,7 +354,7 @@ gh aw trial ./workflow.md --repo owner/repo # Run directly in repository
Execute workflows immediately in GitHub Actions. After triggering, displays workflow URL and suggests using `gh aw audit` to analyze the run.

```bash wrap
gh aw run workflow-name # Run workflow
gh aw run workflow # Run workflow
gh aw run workflow1 workflow2 # Run multiple workflows
gh aw run workflow --repeat 3 # Repeat execution 3 times
gh aw run workflow --use-local-secrets # Use local API keys
Expand Down Expand Up @@ -418,12 +418,12 @@ Download and analyze workflow execution logs. Downloads logs, analyzes tool usag

```bash wrap
gh aw logs # Download logs for all workflows
gh aw logs workflow-name # Download logs for specific workflow
gh aw logs workflow # Download logs for specific workflow
gh aw logs -c 10 --start-date -1w # Filter by count and date
gh aw logs --ref main # Filter logs by branch or tag
gh aw logs --ref v1.0.0 --parse --json # Generate markdown + JSON output for specific tag
gh aw logs --campaign # Filter to only campaign orchestrator workflows
gh aw logs workflow-name --repo owner/repo # Download logs from specific repository
gh aw logs workflow --repo owner/repo # Download logs from specific repository
```

**Options:** `-c, --count N` (limit number of runs), `-e, --engine` (filter by AI engine like `-e copilot`), `--campaign` (filter to only campaign orchestrator workflows), `--start-date` (filter runs from date like `--start-date -1w`), `--end-date` (filter runs until date like `--end-date -1d`), `--ref` (filter by branch or tag like `--ref main` or `--ref v1.0.0`), `--parse` (generate `log.md` and `firewall.md`), `--json` (output structured metrics), `--repo owner/repo` (download logs from specific repository)
Expand Down Expand Up @@ -478,7 +478,7 @@ Enable workflows for execution with pattern matching support for bulk operations
gh aw enable # Enable all workflows
gh aw enable prefix # Enable workflows matching prefix
gh aw enable ci-* # Enable workflows with pattern
gh aw enable workflow-name --repo owner/repo # Enable in specific repository
gh aw enable workflow --repo owner/repo # Enable in specific repository
```

**Options:** `--repo owner/repo` (enable workflows in specific repository, defaults to current)
Expand All @@ -491,7 +491,7 @@ Disable workflows to prevent execution and cancel any currently running workflow
gh aw disable # Disable all workflows
gh aw disable prefix # Disable workflows matching prefix
gh aw disable ci-* # Disable workflows with pattern
gh aw disable workflow-name --repo owner/repo # Disable in specific repository
gh aw disable workflow --repo owner/repo # Disable in specific repository
```

**Options:** `--repo owner/repo` (disable workflows in specific repository, defaults to current)
Expand Down Expand Up @@ -530,10 +530,10 @@ Manage MCP (Model Context Protocol) servers. Lists MCP servers configured in wor

```bash wrap
gh aw mcp list # List all MCP servers
gh aw mcp list workflow-name # List servers for specific workflow
gh aw mcp list workflow # List servers for specific workflow
gh aw mcp list-tools <mcp-server> # List tools for specific MCP server
gh aw mcp list-tools <mcp-server> workflow # List tools in specific workflow
gh aw mcp inspect workflow-name # Inspect and test servers (auto-detects safe-inputs)
gh aw mcp inspect workflow # Inspect and test servers (auto-detects safe-inputs)
gh aw mcp add # Add servers from registry
```

Expand Down