gatewayctl

Reference

gatewayctl

Generated source hash: sha256:fb66c2470aa0dd92632a96f9db99ba0ec398e89f716838d88b64a596af6a8932.

Audience

• Operators using CLI parity for admin workflows.
• Developers checking command names before adding docs examples.
• Reviewers checking that docs do not hand-copy stale CLI surfaces.

What is this?

This page is generated from cmd/gatewayctl/main.go. It lists root commands dispatched by the CLI and preserves the source usage text.

When do I use it?

Use it when writing docs examples or checking whether a browser workflow has CLI parity. Run go run ./cmd/gatewayctl <command> from the repo root for current runtime behavior.

What happens?

• 32 root commands are parsed from the command dispatcher.
• Usage text is copied from the source usage() function.
• Command behavior remains owned by Go source and tests.

Command	Source status
admin-activity	Source-dispatched root command.
bootstrap-admin	Source-dispatched root command.
bootstrap-self-hosted	Source-dispatched root command.
call-tool	Source-dispatched root command.
claude-config	Source-dispatched root command.
client-surface	Source-dispatched root command.
connector-status	Source-dispatched root command.
connectors	Source-dispatched root command.
credential-binding	Source-dispatched root command.
diagnose-deny	Source-dispatched root command.
drain-session	Source-dispatched root command.
emergency-disable	Source-dispatched root command.
environments	Source-dispatched root command.
explain	Source-dispatched root command.
import-api	Source-dispatched root command.
import-openapi	Source-dispatched root command.
inspect-session	Source-dispatched root command.
license	Source-dispatched root command.
list-sessions	Source-dispatched root command.
policy	Source-dispatched root command.
register-agent	Source-dispatched root command.
register-server	Source-dispatched root command.
revoke-session	Source-dispatched root command.
search-audit	Source-dispatched root command.
siem-webhook	Source-dispatched root command.
simulate-policy	Source-dispatched root command.
status	Source-dispatched root command.
telemetry	Source-dispatched root command.
terminate-session	Source-dispatched root command.
validate-agent	Source-dispatched root command.
validate-credential-binding	Source-dispatched root command.
validate-manifest	Source-dispatched root command.

Usage text from source

gatewayctl is the Go CLI shell for registration, validation, OpenAPI import, policy simulation, and diagnostics.
gatewayctl commands: validate-manifest <file> [--format text|json], register-server <manifest> [--registry <file>] [--format text|json], call-tool (--registry <file>|--manifest <file>) [--request <file>|--server <id> --tool <id>], import-api <file> [--api-source <id>] [--allowed-host <host>] [--select <operationId>] [--approve <operationId>] [--operation <operationId>] [--mapping-dir <dir>] [--format text|json], import-openapi <file> [same flags; compatibility alias], simulate-policy [--user <id>] [--group <id>] [--agent <id>] [--client-surface <id>] [--environment <id>] (--server <id>|--api-source <id> --operation <id>) --tool <id> [--allow|--explicit-deny|--revoked-subject|--unauthorized-surface|--environment-mismatch|--credential-mode-denied|--credential-binding-denied|--missing-auth|--invalid-auth] [--policy-version <id>] [--format text|json], diagnose-deny <reason>|--request-id <id>|--audit-event-id <id>|[actor/tool context] [--format text|json], bootstrap-self-hosted [--dry-run] [--format text|json], bootstrap-admin [--control-plane-url <url>] [--user <id>] [--display-name <name>] [--email <email>] [--password-env <env>] [--format text|json], status deployment [--format text|json], validate-agent <manifest> [--format text|json], register-agent <manifest> [--registry <file>] [--format text|json], validate-credential-binding <manifest> [--format text|json], credential-binding (list|get|update|rotate|disable|revoke|status) [id] [--lifecycle approved|disabled|revoked] [--reason <reason>] [--format text|json], search-audit [filters] [--export-ready] [--format text|json], list-sessions [filters] [--format text|json], inspect-session <id> [--format text|json], drain-session <id> --reason <reason> [--format text|json], terminate-session <id> --reason <reason> [--format text|json], revoke-session <id> --reason <reason> [--revocation-id <id>] [--format text|json], emergency-disable --target-type <type> --target-id <id> --reason <reason> [--format text|json], connector-status <id> [--lifecycle approved|disabled|revoked] [--format text|json], policy review <file> --policy-version <id> [--format text|json], policy publish <file> --policy-version <id> [--format text|json], explain
additional commands: status data-planes [filters] [--format text|json], status data-plane <id> [--format text|json], environments list|get [--format text|json], license status [--environment <id>] [--state valid|expired|missing|offline_grace] [--role platform_admin|security_admin|viewer|developer] [--format text|json], telemetry (status|configure|test|disable) [--control-plane-url <url>] [--format text|json], siem-webhook (list|create|update|test|disable) [--control-plane-url <url>] [--format text|json], client-surface (list|get|disable|revoke) [id] [--environment <id>] [--reason <reason-code>] [--format text|json], admin-activity (search|get) [filters] [--format text|json], connectors list --tenant <id> --environment <id> [--format text|json], connectors get|impact <id> --tenant <id> --environment <id> [--format text|json], connectors disable|reenable|revoke <id> --tenant <id> --environment <id> --reason-code <code> --reason <text> --expected-version <version> [--control-plane-url <url>] [--format text|json], claude-config --endpoint <url> [--server-id <id>]

What can go wrong?

• A docs page lists a command that is not dispatched by main.go.
• CLI output examples include private payloads, raw tokens, credential material, or customer data.
• A command is treated as production proof when it is fixture-backed or dry-run only.
• A workflow needs direct database access. V1 operator workflows should use Admin API, CLI, or harness checks.

Source truth

• cmd/gatewayctl/main.go
• apps/docs/scripts/generate-reference-pages.mjs

Next

• Read Admin API for control-plane route contracts.
• Read Operator Workflow for daily baseline commands.
• Read Evals for harness-backed behavior checks.