Skip to content

docs: add missing subcommands to CLI reference (predownload, logs audit)#1608

Merged
Mossaka merged 2 commits intomainfrom
copilot/add-missing-subcommands-to-cli-reference
Apr 2, 2026
Merged

docs: add missing subcommands to CLI reference (predownload, logs audit)#1608
Mossaka merged 2 commits intomainfrom
copilot/add-missing-subcommands-to-cli-reference

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 2, 2026

CLI reference docs are missing awf predownload and awf logs audit subcommands.

Changes

  • awf predownload — Added as top-level subcommand with options table (--image-registry, --image-tag, --agent-image, --enable-api-proxy) and usage examples
  • awf logs audit — Added as logs sub-subcommand with options table (--format, --source, --rule, --domain, --decision), filter examples, and sample pretty output

Both sections follow the existing doc conventions (options tables, admonitions, code blocks). Content derived from src/cli.ts command definitions and src/commands/predownload.ts / src/commands/logs-audit.ts implementations.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node /home/REDACTED/work/gh-aw-firewall/gh-aw-firewall/docs-site/node_modules/.bin/astro build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title [WIP] Add missing subcommands to CLI reference docs: add missing subcommands to CLI reference (predownload, logs audit) Apr 2, 2026
Copilot AI requested a review from Mossaka April 2, 2026 18:24
@Mossaka Mossaka requested a review from Copilot April 2, 2026 18:58
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds missing CLI reference documentation for two subcommands that exist in the codebase: awf predownload and awf logs audit.

Changes:

  • Documented awf predownload with options table, usage, and examples.
  • Documented awf logs audit with options table, filtering examples, and sample “pretty” output.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


### `awf predownload`

Pre-download Docker images for offline use or faster startup. This pulls container images ahead of time so that subsequent `awf` runs can use `--skip-pull` to avoid network calls.
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The intro sentence says subsequent runs can use --skip-pull to “avoid network calls”, but --skip-pull only avoids pulling container images; awf may still make other network requests depending on what’s executed inside the sandbox. Consider tightening this to “avoid pulling images at runtime” (or similar) to keep the claim accurate.

Suggested change
Pre-download Docker images for offline use or faster startup. This pulls container images ahead of time so that subsequent `awf` runs can use `--skip-pull` to avoid network calls.
Pre-download Docker images for offline use or faster startup. This pulls container images ahead of time so that subsequent `awf` runs can use `--skip-pull` to avoid pulling images at runtime.

Copilot uses AI. Check for mistakes.
|--------|------|---------|-------------|
| `--image-registry <registry>` | string | `ghcr.io/github/gh-aw-firewall` | Container image registry |
| `--image-tag <tag>` | string | `latest` | Container image tag (applies to squid, agent, and api-proxy images) |
| `--agent-image <value>` | string | `default` | Agent image preset (`default`, `act`) or custom image |
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--agent-image here is documented as “preset … or custom image”, but the semantics for awf predownload differ from the top-level --agent-image section above (which describes custom base images requiring --build-local). For predownload, non-preset values are treated as a full image reference and are pulled as-is. Consider clarifying that difference (e.g., “preset (default, act) or explicit agent image reference”).

Suggested change
| `--agent-image <value>` | string | `default` | Agent image preset (`default`, `act`) or custom image |
| `--agent-image <value>` | string | `default` | Agent image preset (`default`, `act`) or explicit agent image reference |

Copilot uses AI. Check for mistakes.
@Mossaka Mossaka marked this pull request as ready for review April 2, 2026 21:12
@Mossaka Mossaka merged commit 93407c7 into main Apr 2, 2026
4 checks passed
@Mossaka Mossaka deleted the copilot/add-missing-subcommands-to-cli-reference branch April 2, 2026 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add missing subcommands to CLI reference (predownload, logs audit)

3 participants