diff --git a/docs/usage.md b/docs/usage.md index 20c29923..9c1cb24b 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -6,7 +6,7 @@ sudo awf [options] -- Options: - --allow-domains Comma-separated list of allowed domains. Supports wildcards and protocol prefixes: + -d, --allow-domains Comma-separated list of allowed domains. Supports wildcards and protocol prefixes: - github.com: exact domain + subdomains (HTTP & HTTPS) - *.github.com: any subdomain of github.com - api-*.example.com: prefix wildcards @@ -20,11 +20,11 @@ Options: --block-domains-file Path to file containing blocked domains (one per line or comma-separated, supports # comments) --log-level Log level: debug, info, warn, error (default: info) - --keep-containers Keep containers running after command exits (default: false) + -k, --keep-containers Keep containers running after command exits (default: false) --tty Allocate a pseudo-TTY for the container (required for interactive tools like Claude Code) (default: false) --work-dir Working directory for temporary files - --build-local Build containers locally instead of using GHCR images (default: false) + -b, --build-local Build containers locally instead of using GHCR images (default: false) --agent-image Agent container image (default: "default") Presets (pre-built, fast): default - Minimal ubuntu:22.04 (~200MB) diff --git a/src/cli.ts b/src/cli.ts index b06238e5..271b31a1 100644 --- a/src/cli.ts +++ b/src/cli.ts @@ -665,7 +665,7 @@ program .description('Network firewall for agentic workflows with domain whitelisting') .version(version) .option( - '--allow-domains ', + '-d, --allow-domains ', 'Comma-separated list of allowed domains. Supports wildcards and protocol prefixes:\n' + ' github.com - exact domain + subdomains (HTTP & HTTPS)\n' + ' *.github.com - any subdomain of github.com\n' + @@ -692,7 +692,7 @@ program 'info' ) .option( - '--keep-containers', + '-k, --keep-containers', 'Keep containers running after command exits', false ) @@ -707,7 +707,7 @@ program path.join(os.tmpdir(), `awf-${Date.now()}`) ) .option( - '--build-local', + '-b, --build-local', 'Build containers locally instead of using GHCR images', false )