Files
coder/docs/reference/cli/agent-firewall.md
T
Nick Vigilante d187dea338 docs: end every page description with a period and lint for it (#30863)
## Summary

Page descriptions in the docs were inconsistent about ending with a
period. This makes every page description end with one and adds a lint
so it stays that way.

A page description can come from three places, and the docs site reads
front matter first and falls back to the manifest:

- the hand-written YAML sidebar sources under `docs/manifest/`
(including `children_from` overlays),
- the generated fragments (`docs/manifest/generated/cli.json`,
`rest-api.json`), compiled into `docs/manifest.json`,
- a page's own front matter (today only the generated CLI and API
reference pages carry one).

The check covers all three. For the CLI, the description comes from each
command's `Short`, which stays unpunctuated by CLI-help convention, so
`clidocgen` adds the period when it writes the docs description instead
of changing 120 `Short` strings and the CLI golden files.

## What the lint checks

`make lint/docs-manifest` (`docsmanifestgen check`, already part of
`make lint` in CI) now fails when a non-empty description doesn't end
with `.`. No description in the tree ends with `?` or `!`, so the rule
allows only a period. Errors name the source file, the sidebar
breadcrumb, and the description, for example:

```
install/plan/sizing.yml: Install > Plan your deployment > Coder Validated Architecture > Up to 1,000 users: description must end with a period: "Hardware specifications and architecture guidance for Coder deployments that support up to 1,000 users"
generated/api.json: General: description must end with a period: "General endpoints"
reference/cli/ping.md: Reference > Command Line > `ping`: front matter description must end with a period: "Ping a workspace"
```

The style guide's page-description rule now lists the requirement and
cites the checker, and `styleclaims` recognises
`scripts/docsmanifestgen` so the coverage table counts it as
tool-checked.

## Count of descriptions fixed

147 descriptions in `docs/manifest.json`:

- 27 hand-written descriptions in 15 sidebar source files,
- 120 generated CLI descriptions, which also update the front matter of
120 CLI reference pages.

The REST API descriptions already ended with a period. No description is
otherwise reworded.

## Testing

- New table cases in `scripts/docgenenv` (section route, child route,
overlay, generated fragment, front matter, and a `?` ending) and
`scripts/clidocgen`, written first and failing before the change.
- `docsmanifestgen check` on the unfixed tree reported the 27 source
descriptions; after the fixes and regeneration it passes.
- `go test ./scripts/docgenenv/ ./scripts/clidocgen/
./scripts/docsmanifestgen/ ./scripts/styleclaims/
./scripts/apidocgen/...`
- `golangci-lint run` on the changed packages, `pnpm run check-docs`,
`go run ./scripts/styleclaims`, `scripts/check_emdash.sh`, and
`docsmanifestgen fmt` (no changes).

Linear: [DOCS-1304](https://linear.app/codercom/issue/DOCS-1304)

---

🤖 Built with AI assistance.
2026-10-20 18:51:44 -04:00

6.0 KiB
Generated

title, description
title description
`coder agent-firewall` Network isolation tool for monitoring and restricting HTTP/HTTPS requests.

Network isolation tool for monitoring and restricting HTTP/HTTPS requests

Usage

coder agent-firewall [flags] [args...]

Description

boundary creates an isolated network environment for target processes, intercepting HTTP/HTTPS traffic through a transparent proxy that enforces user-defined allow rules.

Options

--config

Type yaml-config-path
Environment $BOUNDARY_CONFIG

Path to YAML config file.

--allow

Type string
Environment $BOUNDARY_ALLOW

Allow rule (repeatable). These are merged with allowlist from config file. Format: "pattern" or "METHOD[,METHOD] pattern".

--log-level

Type string
Environment $BOUNDARY_LOG_LEVEL
YAML log_level
Default warn

Set log level (error, warn, info, debug).

--log-dir

Type string
Environment $BOUNDARY_LOG_DIR
YAML log_dir

Set a directory to write logs to rather than stderr.

--proxy-port

Type int
Environment $PROXY_PORT
YAML proxy_port
Default 8080

Set a port for HTTP proxy.

--pprof

Type bool
Environment $BOUNDARY_PPROF
YAML pprof_enabled

Enable pprof profiling server.

--pprof-port

Type int
Environment $BOUNDARY_PPROF_PORT
YAML pprof_port
Default 6060

Set port for pprof profiling server.

--jail-type

Type string
Environment $BOUNDARY_JAIL_TYPE
YAML jail_type
Default nsjail

Jail type to use for network isolation. Options: nsjail (default), landjail.

--use-real-dns

Type bool
Environment $BOUNDARY_USE_REAL_DNS
YAML use_real_dns

Use real DNS in the jail instead of the dummy DNS (allows DNS exfiltration). Default: false.

--no-user-namespace

Type bool
Environment $BOUNDARY_NO_USER_NAMESPACE
YAML no_user_namespace

Do not create a user namespace. Use in restricted environments that disallow user NS (e.g. Bottlerocket in EKS auto-mode).

--disable-audit-logs

Type bool
Environment $DISABLE_AUDIT_LOGS
YAML disable_audit_logs

Disable sending of audit logs to the workspace agent when set to true.

--log-proxy-socket-path

Type string
Environment $CODER_AGENT_BOUNDARY_LOG_PROXY_SOCKET_PATH
Default /tmp/boundary-audit.sock

Path to the socket where the boundary log proxy server listens for audit logs.

--version

Type bool

Print version information and exit.

--enable-session-correlation

Type bool
Environment $BOUNDARY_SESSION_CORRELATION_ENABLED
YAML session_correlation_enabled

Enable session correlation header injection. When no inject targets are configured, the target is auto-derived from CODER_AGENT_URL (set automatically inside Coder workspaces). Disable for deployments without Coder AI Gateway in front.

--session-id-inject-target

Type string
Environment $BOUNDARY_SESSION_ID_INJECT_TARGET

Inject target for session correlation headers. Repeat the flag once per target; each value describes exactly one target. Format: domain=<host> [path=<glob>]. Example: --session-id-inject-target "domain=prod.coder.com path=/api/v2/aibridge/*".