mirror of
https://github.com/coder/coder.git
synced 2026-06-05 05:58:20 +00:00
Sas Swart
52722b800b
Renames the `coder boundary` CLI subcommand to `coder agent-firewall` as part of the Boundaries → Agent Firewall rebrand. `coder boundary` is retained as a hidden, deprecated alias that prints a deprecation notice to stderr before running. Both commands use separate builder functions backed by the same boundary base command and license verification logic. Closes https://linear.app/codercom/issue/AIGOV-236 <details><summary>Implementation notes</summary> **Approach:** Two separate `*serpent.Command` objects (not `Aliases`) so the deprecated `boundary` path can print a stderr warning while `agent-firewall` stays clean. **Changes:** - `enterprise/cli/boundary.go`: Split old `boundary()` into `buildAgentFirewallCmd()` and `buildBoundaryAliasCmd()`. Error messages in `verifyLicense` now reference "agent-firewall". - `enterprise/cli/root.go`: Register both commands. - `cli/root.go`: Update YAML-only option validation bypass for the new command name. - Tests: Rename to `TestAgentFirewallSubcommand`, add `TestBoundaryAlias`, update license verification tests to use `agent-firewall`. - Golden files and CLI reference docs regenerated. - `docs/ai-coder/agent-firewall/version.md` and `docs/manifest.json` updated. </details> > Generated with [Coder Agents](https://coder.com/agents) by @SasSwart
223 lines
15 KiB
Markdown
Generated
223 lines
15 KiB
Markdown
Generated
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
|
# coder
|
|
|
|
## Usage
|
|
|
|
```console
|
|
coder [global-flags] <subcommand>
|
|
```
|
|
|
|
## Description
|
|
|
|
```console
|
|
Coder — A tool for provisioning self-hosted development environments with Terraform.
|
|
- Start a Coder server:
|
|
|
|
$ coder server
|
|
|
|
- Get started by creating a template from an example:
|
|
|
|
$ coder templates init
|
|
```
|
|
|
|
## Subcommands
|
|
|
|
| Name | Purpose |
|
|
|--------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
|
|
| [<code>completion</code>](./completion.md) | Install or update shell completion scripts for the detected or chosen shell. |
|
|
| [<code>dotfiles</code>](./dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository |
|
|
| [<code>external-auth</code>](./external-auth.md) | Manage external authentication |
|
|
| [<code>login</code>](./login.md) | Authenticate with Coder deployment |
|
|
| [<code>logout</code>](./logout.md) | Unauthenticate your local session |
|
|
| [<code>netcheck</code>](./netcheck.md) | Print network debug information for DERP and STUN |
|
|
| [<code>notifications</code>](./notifications.md) | Manage Coder notifications |
|
|
| [<code>organizations</code>](./organizations.md) | Organization related commands |
|
|
| [<code>port-forward</code>](./port-forward.md) | Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". |
|
|
| [<code>publickey</code>](./publickey.md) | Output your Coder public key used for Git operations |
|
|
| [<code>reset-password</code>](./reset-password.md) | Directly connect to the database to reset a user's password |
|
|
| [<code>secret</code>](./secret.md) | Manage secrets |
|
|
| [<code>state</code>](./state.md) | Manually manage Terraform state to fix broken workspaces |
|
|
| [<code>task</code>](./task.md) | Manage tasks |
|
|
| [<code>templates</code>](./templates.md) | Manage templates |
|
|
| [<code>tokens</code>](./tokens.md) | Manage personal access tokens |
|
|
| [<code>users</code>](./users.md) | Manage users |
|
|
| [<code>version</code>](./version.md) | Show coder version |
|
|
| [<code>autoupdate</code>](./autoupdate.md) | Toggle auto-update policy for a workspace |
|
|
| [<code>config-ssh</code>](./config-ssh.md) | Add an SSH Host entry for your workspaces "ssh workspace.coder" |
|
|
| [<code>create</code>](./create.md) | Create a workspace |
|
|
| [<code>delete</code>](./delete.md) | Delete a workspace |
|
|
| [<code>favorite</code>](./favorite.md) | Add a workspace to your favorites |
|
|
| [<code>list</code>](./list.md) | List workspaces |
|
|
| [<code>logs</code>](./logs.md) | View logs for a workspace |
|
|
| [<code>open</code>](./open.md) | Open a workspace |
|
|
| [<code>ping</code>](./ping.md) | Ping a workspace |
|
|
| [<code>rename</code>](./rename.md) | Rename a workspace |
|
|
| [<code>restart</code>](./restart.md) | Restart a workspace |
|
|
| [<code>schedule</code>](./schedule.md) | Schedule automated start and stop times for workspaces |
|
|
| [<code>show</code>](./show.md) | Display details of a workspace's resources and agents |
|
|
| [<code>speedtest</code>](./speedtest.md) | Run upload and download tests from your machine to a workspace |
|
|
| [<code>ssh</code>](./ssh.md) | Start a shell into a workspace or run a command |
|
|
| [<code>start</code>](./start.md) | Start a workspace |
|
|
| [<code>stat</code>](./stat.md) | Show resource usage for the current workspace. |
|
|
| [<code>stop</code>](./stop.md) | Stop a workspace |
|
|
| [<code>unfavorite</code>](./unfavorite.md) | Remove a workspace from your favorites |
|
|
| [<code>update</code>](./update.md) | Will update and start a given workspace if it is out of date. If the workspace is already running, it will be stopped first. |
|
|
| [<code>whoami</code>](./whoami.md) | Fetch authenticated user info for Coder deployment |
|
|
| [<code>support</code>](./support.md) | Commands for troubleshooting issues with a Coder deployment. |
|
|
| [<code>server</code>](./server.md) | Start a Coder server |
|
|
| [<code>provisioner</code>](./provisioner.md) | View and manage provisioner daemons and jobs |
|
|
| [<code>agent-firewall</code>](./agent-firewall.md) | Network isolation tool for monitoring and restricting HTTP/HTTPS requests |
|
|
| [<code>features</code>](./features.md) | List Enterprise features |
|
|
| [<code>licenses</code>](./licenses.md) | Add, delete, and list licenses |
|
|
| [<code>groups</code>](./groups.md) | Manage groups |
|
|
| [<code>prebuilds</code>](./prebuilds.md) | Manage Coder prebuilds |
|
|
| [<code>external-workspaces</code>](./external-workspaces.md) | Create or manage external workspaces |
|
|
| [<code>aibridge</code>](./aibridge.md) | Manage AI Bridge. |
|
|
|
|
## Options
|
|
|
|
### --url
|
|
|
|
| | |
|
|
|-------------|-------------------------|
|
|
| Type | <code>url</code> |
|
|
| Environment | <code>$CODER_URL</code> |
|
|
|
|
URL to a deployment.
|
|
|
|
### --debug-options
|
|
|
|
| | |
|
|
|------|-------------------|
|
|
| Type | <code>bool</code> |
|
|
|
|
Print all options, how they're set, then exit.
|
|
|
|
### --token
|
|
|
|
| | |
|
|
|-------------|-----------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$CODER_SESSION_TOKEN</code> |
|
|
|
|
Specify an authentication token. For security reasons setting CODER_SESSION_TOKEN is preferred.
|
|
|
|
### --no-version-warning
|
|
|
|
| | |
|
|
|-------------|----------------------------------------|
|
|
| Type | <code>bool</code> |
|
|
| Environment | <code>$CODER_NO_VERSION_WARNING</code> |
|
|
|
|
Suppress warning when client and server versions do not match.
|
|
|
|
### --no-feature-warning
|
|
|
|
| | |
|
|
|-------------|----------------------------------------|
|
|
| Type | <code>bool</code> |
|
|
| Environment | <code>$CODER_NO_FEATURE_WARNING</code> |
|
|
|
|
Suppress warnings about unlicensed features.
|
|
|
|
### --header
|
|
|
|
| | |
|
|
|-------------|----------------------------|
|
|
| Type | <code>string-array</code> |
|
|
| Environment | <code>$CODER_HEADER</code> |
|
|
|
|
Additional HTTP headers added to all requests. Provide as key=value. Can be specified multiple times.
|
|
|
|
### --header-command
|
|
|
|
| | |
|
|
|-------------|------------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$CODER_HEADER_COMMAND</code> |
|
|
|
|
An external command that outputs additional HTTP headers added to all requests. The command must output each header as `key=value` on its own line.
|
|
|
|
### --force-tty
|
|
|
|
| | |
|
|
|-------------|-------------------------------|
|
|
| Type | <code>bool</code> |
|
|
| Environment | <code>$CODER_FORCE_TTY</code> |
|
|
|
|
Force the use of a TTY.
|
|
|
|
### -v, --verbose
|
|
|
|
| | |
|
|
|-------------|-----------------------------|
|
|
| Type | <code>bool</code> |
|
|
| Environment | <code>$CODER_VERBOSE</code> |
|
|
|
|
Enable verbose output.
|
|
|
|
### --disable-direct-connections
|
|
|
|
| | |
|
|
|-------------|------------------------------------------------|
|
|
| Type | <code>bool</code> |
|
|
| Environment | <code>$CODER_DISABLE_DIRECT_CONNECTIONS</code> |
|
|
|
|
Disable direct (P2P) connections to workspaces.
|
|
|
|
### --disable-network-telemetry
|
|
|
|
| | |
|
|
|-------------|-----------------------------------------------|
|
|
| Type | <code>bool</code> |
|
|
| Environment | <code>$CODER_DISABLE_NETWORK_TELEMETRY</code> |
|
|
|
|
Disable network telemetry. Network telemetry is collected when connecting to workspaces using the CLI, and is forwarded to the server. If telemetry is also enabled on the server, it may be sent to Coder. Network telemetry is used to measure network quality and detect regressions.
|
|
|
|
### --client-tls-ca-file
|
|
|
|
| | |
|
|
|-------------|----------------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$CODER_CLIENT_TLS_CA_FILE</code> |
|
|
|
|
Path to a CA certificate file to trust for API and DERP connections.
|
|
|
|
### --client-tls-cert-file
|
|
|
|
| | |
|
|
|-------------|------------------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$CODER_CLIENT_TLS_CERT_FILE</code> |
|
|
|
|
Path to a client certificate file for mTLS authentication with API and DERP. Requires --client-tls-key-file.
|
|
|
|
### --client-tls-key-file
|
|
|
|
| | |
|
|
|-------------|-----------------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$CODER_CLIENT_TLS_KEY_FILE</code> |
|
|
|
|
Path to a client private key file for mTLS authentication with API and DERP. Requires --client-tls-cert-file.
|
|
|
|
### --use-keyring
|
|
|
|
| | |
|
|
|-------------|---------------------------------|
|
|
| Type | <code>bool</code> |
|
|
| Environment | <code>$CODER_USE_KEYRING</code> |
|
|
| Default | <code>true</code> |
|
|
|
|
Store and retrieve session tokens using the operating system keyring. This flag is ignored and file-based storage is used when --global-config is set or keyring usage is not supported on the current platform. Set to false to force file-based storage on supported platforms.
|
|
|
|
### --global-config
|
|
|
|
| | |
|
|
|-------------|--------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$CODER_CONFIG_DIR</code> |
|
|
| Default | <code>~/.config/coderv2</code> |
|
|
|
|
Path to the global `coder` config directory.
|