Skip to content

[docs] Sync CLI flags and agent image presets with code#861

Open
github-actions[bot] wants to merge 1 commit intomainfrom
docs/sync-cli-flags-feb-2026-3ea480ff741b8d6b
Open

[docs] Sync CLI flags and agent image presets with code#861
github-actions[bot] wants to merge 1 commit intomainfrom
docs/sync-cli-flags-feb-2026-3ea480ff741b8d6b

Conversation

@github-actions
Copy link
Contributor

Documentation Sync - February 8-15, 2026

This PR synchronizes documentation with the current codebase (commit c4eba9e from Feb 14, 2026).

Changes Made

1. Updated docs/usage.md - Added missing CLI flags and enhanced descriptions:

  • Added --allow-full-filesystem-access flag with security warning
  • Added --enable-api-proxy flag for API proxy sidecar
  • Enhanced --allow-domains description with wildcard and protocol prefix examples
  • Enhanced --agent-image description with preset details (default, act) and custom image options
  • Added default values for boolean flags (e.g., (default: false))
  • Improved descriptions for --dns-servers, --enable-host-access, --allow-host-ports, and other flags to match actual CLI help output

2. Updated docs/agent-images.md - Clarified agent image preset naming:

  • Changed section headers to use preset names (default and act) instead of image names (agent and agent-act)
  • Added table column for "Preset" vs "Actual Image" to clarify the distinction
  • Updated section titles: "Default Preset (default) - Tools" and "Act Preset (act) - Tools"
  • Added example showing explicit --agent-image default usage

3. Updated docs/quickstart.md - Fixed version reference:

  • Changed example version from 0.17.0 to 0.18.0 to match package.json

Code Changes Referenced

  • Commit c4eba9e: Initial repository commit with version 0.18.0
  • CLI implementation in src/cli.ts defines presets as ['default', 'act']
  • CLI help output includes comprehensive flag descriptions that were missing from docs

Verification

  • ✅ Compared CLI help output (node dist/cli.js --help) with documented flags
  • ✅ Verified preset names (default, act) match code implementation
  • ✅ Checked version number matches package.json (0.18.0)
  • ✅ Verified flag descriptions are accurate and complete
  • ✅ Ensured consistent terminology throughout updated documentation

AI generated by Documentation Maintainer

@github-actions github-actions bot added ai-generated documentation Improvements or additions to documentation labels Feb 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-generated documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants