docs: clarify --image-tag behavior with agent-image presets#1228
docs: clarify --image-tag behavior with agent-image presets#1228
Conversation
The --image-tag flag applies to both squid and agent images, but the agent image name varies by preset: 'default' uses agent:<tag> while 'act' uses agent-act:<tag>. Updated help text and usage docs to make this interaction clear. Fixes #502 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
✅ Coverage Check PassedOverall Coverage
📁 Per-file Coverage Changes (1 files)
Coverage comparison generated by |
There was a problem hiding this comment.
Pull request overview
Updates CLI help and user docs to clarify how --image-tag maps to different agent image names depending on the --agent-image preset (per issue #502).
Changes:
- Expanded
--image-taghelp text in the CLI to document preset-dependent agent image naming (agent:<tag>vsagent-act:<tag>). - Updated
docs/usage.mdto include the same clarification alongside the--image-tagoption.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/cli.ts | Extends --image-tag help text with preset-dependent image-name mapping. |
| docs/usage.md | Mirrors the CLI clarification in the usage documentation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| .option( | ||
| '--image-tag <tag>', | ||
| 'Container image tag', | ||
| 'Container image tag (applies to both squid and agent images)\n' + |
There was a problem hiding this comment.
The new help text implies --image-tag always applies to both Squid and agent images, but when --build-local is set both services are built locally (no image: is set in the generated compose), so the tag is effectively ignored. Consider qualifying this description with something like “when pulling pre-built images from --image-registry (i.e., without --build-local)” and/or noting that --image-tag doesn’t affect locally-built images.
| 'Container image tag (applies to both squid and agent images)\n' + | |
| 'Container image tag for pre-built images from --image-registry (applies to both squid and agent images when not using --build-local; has no effect on locally-built images)\n' + |
| ghcr.io/catthehacker/ubuntu:full-XX.XX | ||
| --image-registry <registry> Container image registry (default: ghcr.io/github/gh-aw-firewall) | ||
| --image-tag <tag> Container image tag (default: latest) | ||
| Image name varies by --agent-image preset: |
There was a problem hiding this comment.
This clarification is accurate for preset GHCR images, but --image-tag is ignored when --build-local is used (compose builds services locally and doesn’t use registry/tag). Consider adding a short qualifier (e.g., “when pulling preset images / without --build-local”) to avoid implying the name/tag mapping always applies.
| Image name varies by --agent-image preset: | |
| Image name (when pulling preset images, i.e., without --build-local) varies by --agent-image preset: |
Smoke Test Results✅ GitHub MCP: #1162 test: add chroot escape vector test coverage | #1161 test: add TOCTOU error path coverage for ssl-bump.ts Overall: PASS
|
🏗️ Build Test Suite Results
Overall: 0/8 ecosystems passed — ❌ FAIL ❌ Error DetailsALL_CLONES_FAILED: All 8 repository clones failed because This affected all ecosystems: Bun, C++, Deno, .NET, Go, Java, Node.js, and Rust. No tests could be executed.
|
|
PR titles: test: add workDir tmpfs hiding integration tests | test: add chroot escape vector test coverage
|
|
🤖 Smoke test results for run
Overall: PASS — authored by
|
Chroot Version Comparison Results
Result: ❌ Not all tests passed — Python and Node.js versions differ between host and chroot.
|
Summary
--image-taghelp text in CLI to explain that the image name varies by--agent-imagepreset (default→agent:<tag>,act→agent-act:<tag>)docs/usage.mdwith the same clarificationFixes #502
Test plan
npm run buildpassesnpm testpasses (839 tests)npm run lintpasses (warnings only, no errors)awf --helpshows updated--image-tagdescription🤖 Generated with Claude Code