Autogenerated command reference for the current Apoxy checkout beside this repo.

apoxy

Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.

Synopsis

Apoxy is an open-source edge platform built on Envoy, Kubernetes API infrastructure, and QUIC tunneling. Core capabilities include:

API Gateway with Gateway API routing
Edge computing runtime for JS/WASM/Go functions
Secure tunneling via QUIC and connect-ip protocols

Apoxy Cloud is the managed offering — it handles DNS registration, instant TLS certificates, and built-in observability so you focus on routing and logic instead of infrastructure.

Get started at https://apoxy.dev and log in with 'apoxy auth'.

Options

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
  -h, --help              help for apoxy
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy alpha

Alpha features that are still under development

apoxy alpha [flags]

Options

  -h, --help   help for alpha

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy alpha domains

Manage domain record objects

Synopsis

Domain records configure individual DNS records within a domain zone.

apoxy alpha domains [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for domains
  -o, --output string           Output format: "json" or "yaml". Default is table.
      --zone string             Filter domain records by zone name.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy alpha domains apply

Apply domainrecord configuration using server-side apply

Synopsis

Apply domainrecord configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update domainrecord objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

apoxy alpha domains apply [-f filename] [flags]

Options

      --field-manager string   Name of the field manager for server-side apply. (default "apoxy-cli")
  -f, --filename string        The file that contains the configuration to apply.
      --force-conflicts        Force apply even if there are field ownership conflicts.
  -h, --help                   help for apply

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy alpha domains create

Create domainrecord objects

Synopsis

Create domainrecord objects by providing a configuration as a file or via stdin.

apoxy alpha domains create [-f filename] [flags]

Options

  -f, --filename string   The file that contains the configuration to create.
  -h, --help              help for create

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy alpha domains delete

Delete domainrecord objects

apoxy alpha domains delete [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy alpha domains get

Get domainrecord objects

apoxy alpha domains get <name> [flags]

Options

  -h, --help            help for get
  -o, --output string   Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy alpha domains list

List domainrecord objects

apoxy alpha domains list [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for list
  -o, --output string           Output format: "json" or "yaml". Default is table.
      --show-labels             Print the domainrecord's labels.
      --zone string             Filter domain records by zone name.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy alpha tunnel

Manage tunnels

Synopsis

Manage icx tunnels and connect to the remote Apoxy Edge fabric.

Options

  -h, --help   help for tunnel

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy alpha tunnel run

Run a tunnel

Synopsis

Create a secure tunnel to the remote Apoxy Edge fabric.

apoxy alpha tunnel run [flags]

Options

  -a, --agent string           The name of this agent.
      --health-addr string     Listen address for health endpoint (e.g. ":8080"). Empty disables. (default "localhost:8080")
  -h, --help                   help for run
      --insecure-skip-verify   Skip TLS certificate verification for relay connections.
      --min-conns int          Minimum number of relays to maintain connections to (randomly selected from the server-provided list). (default 1)
  -n, --name string            The logical name of the tunnel to connect to.
  -p, --pcap string            Path to an optional packet capture file to write.
  -r, --relay-addr string      Seed relay address (host:port), required if not using kubernetes-based discovery.
      --socks-addr string      Listen address for SOCKS proxy. (default "localhost:1080")
  -k, --token string           The token to use for authenticating with the tunnel relays, required if not using kubernetes-based discovery.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy apply

Apply resources from file(s) or directory

Synopsis

Apply configuration to resources using server-side apply.

Supports multiple files, directories, and stdin. When a directory is specified, all .yaml, .yml, and .json files are processed.

Examples:

Apply a single file

apoxy apply -f gateway.yaml

Apply multiple files

apoxy apply -f gateway.yaml -f routes.yaml

Apply all manifests in a directory

apoxy apply -f ./manifests/

Apply from stdin

cat manifest.yaml | apoxy apply -f -

apoxy apply -f <filename> [flags]

Options

      --field-manager string   Name of the field manager for server-side apply (default "apoxy-cli")
  -f, --filename stringArray   Files or directories containing resources to apply (can be specified multiple times)
      --force-conflicts        Force apply even if there are field ownership conflicts
  -h, --help                   help for apply
  -R, --recursive              Process directories recursively

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy auth

Authenticate this CLI

Synopsis

If you are not authenticated, this will open a browser window to login via the Apoxy Dashboard.

If your CLI is already authenticated this will return information about your session.

apoxy auth [flags]

Options

      --api-base-url string    API base URL (default: https://api.apoxy.dev)
      --check                  only check the authentication status
      --dashboard-url string   dashboard URL for authentication (default: https://dashboard.apoxy.dev)
  -h, --help                   help for auth

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy backend

Manage backend objects

Synopsis

Backends configure upstream endpoints for proxies.

apoxy backend [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for backend
  -o, --output string           Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy backend apply

Apply backend configuration using server-side apply

Synopsis

Apply backend configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update backend objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

apoxy backend apply [-f filename] [flags]

Options

      --field-manager string   Name of the field manager for server-side apply. (default "apoxy-cli")
  -f, --filename string        The file that contains the configuration to apply.
      --force-conflicts        Force apply even if there are field ownership conflicts.
  -h, --help                   help for apply

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy backend create

Create backend objects

Synopsis

Create backend objects by providing a configuration as a file or via stdin.

apoxy backend create [-f filename] [flags]

Options

  -f, --filename string   The file that contains the configuration to create.
  -h, --help              help for create

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy backend delete

Delete backend objects

apoxy backend delete [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy backend get

Get backend objects

apoxy backend get <name> [flags]

Options

  -h, --help            help for get
  -o, --output string   Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy backend list

List backend objects

apoxy backend list [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for list
  -o, --output string           Output format: "json" or "yaml". Default is table.
      --show-labels             Print the backend's labels.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy delete

Delete resources by file or type/name

Synopsis

Delete resources identified in file(s), directories, stdin, or by type and name.

Supports two modes:

File-based: delete resources specified in YAML/JSON files, directories, or stdin.
Type+name: delete one or more resources by specifying the resource type and name(s).

When a directory is specified with -f, all .yaml, .yml, and .json files are processed.

Examples:

Delete resources in a single file

apoxy delete -f gateway.yaml

Delete resources in multiple files

apoxy delete -f gateway.yaml -f routes.yaml

Delete all resources in a directory

apoxy delete -f ./manifests/

Delete from stdin

cat manifest.yaml | apoxy delete -f -

Delete a resource by type and name

apoxy delete proxy my-proxy

Delete multiple resources by type and name

apoxy delete backend backend-a backend-b

Delete a resource, ignoring if it doesn't exist

apoxy delete proxy my-proxy --ignore-not-found

Delete and wait for the resource to be fully removed

apoxy delete proxy my-proxy --wait

apoxy delete (-f <filename> | <type> <name> [<name>...]) [flags]

Options

  -f, --filename stringArray   Files or directories containing resources to delete (can be specified multiple times)
  -h, --help                   help for delete
      --ignore-not-found       Treat "resource not found" as a successful delete
  -R, --recursive              Process directories recursively
      --timeout duration       Timeout for --wait (e.g. 30s, 2m) (default 1m0s)
      --wait                   Wait for the resource to be fully deleted before returning

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy dev

Develop against the Apoxy API locally

apoxy dev [path/to/proxy.yaml] [flags]

Options

      --clickhouse-addr string   ClickHouse address (host only, port 9000 will be used).
  -h, --help                     help for dev
      --use-subprocess           Use subprocess for apiserver and backplane.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy domain

Manage domain record objects

Synopsis

Domain records configure DNS records and routing for your services.

apoxy domain [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for domain
  -o, --output string           Output format: "json" or "yaml". Default is table.
      --zone string             Filter domain records by zone name.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy domain apply

Apply domainrecord configuration using server-side apply

Synopsis

Apply domainrecord configuration using Kubernetes server-side apply.

apoxy domain apply [-f filename] [flags]

Options

      --field-manager string   Name of the field manager for server-side apply. (default "apoxy-cli")
  -f, --filename string        The file that contains the configuration to apply.
      --force-conflicts        Force apply even if there are field ownership conflicts.
  -h, --help                   help for apply

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy domain create

Create domainrecord objects

Synopsis

Create domainrecord objects by providing a configuration as a file or via stdin.

apoxy domain create [-f filename] [flags]

Options

  -f, --filename string   The file that contains the configuration to create.
  -h, --help              help for create

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy domain delete

Delete domainrecord objects

apoxy domain delete [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy domain get

Get domainrecord objects

apoxy domain get <name> [flags]

Options

  -h, --help            help for get
  -o, --output string   Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy domain list

List domainrecord objects

apoxy domain list [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for list
  -o, --output string           Output format: "json" or "yaml". Default is table.
      --show-labels             Print the domainrecord's labels.
      --zone string             Filter domain records by zone name.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy domain zone

Manage domain zone objects

Synopsis

Domain zones represent DNS zones that domains are managed under.

apoxy domain zone [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for zone
  -o, --output string           Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy domain zone apply

Apply domainzone configuration using server-side apply

Synopsis

Apply domainzone configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update domainzone objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

apoxy domain zone apply [-f filename] [flags]

Options

      --field-manager string   Name of the field manager for server-side apply. (default "apoxy-cli")
  -f, --filename string        The file that contains the configuration to apply.
      --force-conflicts        Force apply even if there are field ownership conflicts.
  -h, --help                   help for apply

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy domain zone create

Create domainzone objects

Synopsis

Create domainzone objects by providing a configuration as a file or via stdin.

apoxy domain zone create [-f filename] [flags]

Options

  -f, --filename string   The file that contains the configuration to create.
  -h, --help              help for create

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy domain zone delete

Delete domainzone objects

apoxy domain zone delete [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy domain zone get

Get domainzone objects

apoxy domain zone get <name> [flags]

Options

  -h, --help            help for get
  -o, --output string   Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy domain zone list

List domainzone objects

apoxy domain zone list [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for list
  -o, --output string           Output format: "json" or "yaml". Default is table.
      --show-labels             Print the domainzone's labels.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy edgefunction

Manage edge function objects

Synopsis

Edge functions allow you to run custom code at the edge of the Apoxy network.

apoxy edgefunction [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for edgefunction
  -o, --output string           Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy edgefunction apply

Apply edge function configuration using server-side apply

Synopsis

Apply edge function configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update edge function objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

apoxy edgefunction apply [-f filename] [flags]

Options

      --field-manager string   Name of the field manager for server-side apply. (default "apoxy-cli")
  -f, --filename string        The file that contains the configuration to apply.
      --force-conflicts        Force apply even if there are field ownership conflicts.
  -h, --help                   help for apply

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy edgefunction create

Create edge function objects

Synopsis

Create edge function objects by providing a configuration as a file or via stdin.

apoxy edgefunction create [-f filename] [flags]

Options

  -f, --filename string   The file that contains the configuration to create.
  -h, --help              help for create

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy edgefunction delete

Delete edge function objects

apoxy edgefunction delete [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy edgefunction get

Get edge function objects

apoxy edgefunction get <name> [flags]

Options

  -h, --help            help for get
  -o, --output string   Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy edgefunction list

List edge function objects

apoxy edgefunction list [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for list
  -o, --output string           Output format: "json" or "yaml". Default is table.
      --show-labels             Print the edge function's labels.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy gateway

Manage gateway objects

Synopsis

The gateway object in the Apoxy API.

apoxy gateway [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for gateway
  -o, --output string           Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy gateway apply

Apply gateway configuration using server-side apply

Synopsis

Apply gateway configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update gateway objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

apoxy gateway apply [-f filename] [flags]

Options

      --field-manager string   Name of the field manager for server-side apply. (default "apoxy-cli")
  -f, --filename string        The file that contains the configuration to apply.
      --force-conflicts        Force apply even if there are field ownership conflicts.
  -h, --help                   help for apply

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy gateway create

Create gateway objects

Synopsis

Create gateway objects by providing a configuration as a file or via stdin.

apoxy gateway create [-f filename] [flags]

Options

  -f, --filename string   The file that contains the configuration to create.
  -h, --help              help for create

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy gateway delete

Delete gateway objects

apoxy gateway delete [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy gateway get

Get gateway objects

apoxy gateway get <name> [flags]

Options

  -h, --help            help for get
  -o, --output string   Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy gateway list

List gateway objects

apoxy gateway list [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for list
  -o, --output string           Output format: "json" or "yaml". Default is table.
      --show-labels             Print the gateway's labels.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy gateway routes

Manage gateway routes (HTTP, TCP, TLS)

Synopsis

Manage routes attached to gateways. Supports HTTPRoute, TCPRoute, and TLSRoute resources.

apoxy gateway routes [flags]

Options

  -h, --help            help for routes
  -o, --output string   Output format: "json" or "yaml". Default is table.
      --show-labels     Print the route's labels.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy gateway routes apply

Apply a route configuration using server-side apply

Synopsis

Apply a route configuration using Kubernetes server-side apply. The route type is detected from the file.

apoxy gateway routes apply [-f filename] [flags]

Options

      --field-manager string   Name of the field manager for server-side apply. (default "apoxy-cli")
  -f, --filename string        File containing the route configuration.
      --force-conflicts        Force apply even if there are field ownership conflicts.
  -h, --help                   help for apply

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy gateway routes create

Create a route from file

Synopsis

Create a route from a YAML or JSON file. The route type is detected from the file.

apoxy gateway routes create [-f filename] [flags]

Options

  -f, --filename string   File containing the route configuration.
  -h, --help              help for create

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy gateway routes delete

Delete a route by name

Synopsis

Delete a route by name. Optionally specify the type as a prefix.

Examples: apoxy gateway routes delete my-route # delete HTTPRoute (default) apoxy gateway routes delete http/my-route # delete HTTPRoute apoxy gateway routes delete tcp/my-route # delete TCPRoute apoxy gateway routes delete tls/my-route # delete TLSRoute

apoxy gateway routes delete [TYPE/]<name> [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy gateway routes get

Get a route by name

Synopsis

Get a route by name. Optionally specify the type as a prefix.

Examples: apoxy gateway routes get my-route # get HTTPRoute (default) apoxy gateway routes get http/my-route # get HTTPRoute apoxy gateway routes get tcp/my-route # get TCPRoute apoxy gateway routes get tls/my-route # get TLSRoute

apoxy gateway routes get [TYPE/]<name> [flags]

Options

  -h, --help            help for get
  -o, --output string   Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy gateway routes list

List all routes

apoxy gateway routes list [flags]

Options

  -h, --help            help for list
  -o, --output string   Output format: "json" or "yaml". Default is table.
      --show-labels     Print the route's labels.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy k8s

Commands that manage Apoxy on Kubernetes

Options

  -h, --help   help for k8s

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy k8s install

Install Apoxy Controller in Kubernetes

Synopsis

Install the Apoxy Controller into the target Kubernetes cluster.

This will create a new namespace and deploy the controller and supporting resources. The controller will automatically connect to the Apoxy API and begin managing your in-cluster Apoxy resources.

apoxy k8s install [flags]

Options

      --cluster-name string   Cluster name identifier (defaults to kube context name)
      --context string        Kubernetes context to use from the kubeconfig file
      --dry-run               If true, only print the YAML that would be applied
      --force                 If true, forces value overwrites (See: https://v1-28.docs.kubernetes.io/docs/reference/using-api/server-side-apply/#conflicts)
  -h, --help                  help for install
      --image string          Controller image override to pass to the onboarding manifest generator
      --kubeconfig string     Path to the kubeconfig file to use for Kubernetes API access
      --mirror string         Mirror mode (gateway, ingress, all)
      --namespace string      The namespace to install the controller into (default "apoxy")
      --version string        Controller version override (e.g. v0.3.0)
  -y, --yes                   Skip confirmation and apply changes immediately

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy logs

View proxy logs

Synopsis

View the request/process logs generated by your proxies. Logs can be filtered by proxy instance and/or date range. By default, logs are streamed in real-time.

apoxy logs [flags]

Options

  -f, --follow              Follow logs in real-time
  -h, --help                help for logs
      --json                Output in raw JSON format
  -p, --proxy string        Proxy name
      --since duration      Show logs since a given duration (e.g. 5m, 1h)
      --since-time string   Show logs from a given date (e.g. 2019-01-01T00:00:00Z)

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy proxy

Manage proxy objects

Synopsis

The controllers object in the Apoxy API.

apoxy proxy [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for proxy
  -o, --output string           Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy proxy apply

Apply proxy configuration using server-side apply

Synopsis

Apply proxy configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update proxy objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

apoxy proxy apply [-f filename] [flags]

Options

      --field-manager string   Name of the field manager for server-side apply. (default "apoxy-cli")
  -f, --filename string        The file that contains the configuration to apply.
      --force-conflicts        Force apply even if there are field ownership conflicts.
  -h, --help                   help for apply

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy proxy create

Create proxy objects

Synopsis

Create proxy objects by providing a configuration as a file or via stdin.

apoxy proxy create [-f filename] [flags]

Options

  -f, --filename string   The file that contains the configuration to create.
  -h, --help              help for create

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy proxy delete

Delete proxy objects

apoxy proxy delete [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy proxy get

Get proxy objects

apoxy proxy get <name> [flags]

Options

  -h, --help            help for get
  -o, --output string   Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy proxy list

List proxy objects

apoxy proxy list [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for list
  -o, --output string           Output format: "json" or "yaml". Default is table.
      --show-labels             Print the proxy's labels.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy run

Run Apoxy runtime components defined in config

Synopsis

Start and monitor all runtime components specified in the config file's runtime section.

Components are defined under runtime.components in the config. Example:

runtime: components:

type: kube-aggregation kubeAggregation: clusterName: "prod-us-east-1" namespace: "apoxy"
type: kube-mirror kubeMirror: mirror: "all"
type: tunnel tunnel: mode: "kernel"

apoxy run [flags]

Options

  -h, --help   help for run

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy tunnel

Manage tunnels

Synopsis

Manage WireGuard tunnels state and connect to the remote Apoxy Edge fabric.

apoxy tunnel [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for tunnel
  -o, --output string           Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy tunnel apply

Apply tunnelnode configuration using server-side apply

Synopsis

Apply tunnelnode configuration using Kubernetes server-side apply.

This command uses server-side apply to create or update tunnelnode objects. Server-side apply tracks field ownership and allows multiple actors to manage different fields of the same object without conflicts.

apoxy tunnel apply [-f filename] [flags]

Options

      --field-manager string   Name of the field manager for server-side apply. (default "apoxy-cli")
  -f, --filename string        The file that contains the configuration to apply.
      --force-conflicts        Force apply even if there are field ownership conflicts.
  -h, --help                   help for apply

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy tunnel create

Create tunnelnode objects

Synopsis

Create tunnelnode objects by providing a configuration as a file or via stdin.

apoxy tunnel create [-f filename] [flags]

Options

  -f, --filename string   The file that contains the configuration to create.
  -h, --help              help for create

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy tunnel delete

Delete tunnelnode objects

apoxy tunnel delete [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy tunnel get

Get tunnelnode objects

apoxy tunnel get <name> [flags]

Options

  -h, --help            help for get
  -o, --output string   Output format: "json" or "yaml". Default is table.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy tunnel list

List tunnelnode objects

apoxy tunnel list [flags]

Options

      --field-selector string   Filter list results by field selectors (e.g. spec.zone=example.com).
  -h, --help                    help for list
  -o, --output string           Output format: "json" or "yaml". Default is table.
      --show-labels             Print the tunnelnode's labels.

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy tunnel run

Run a tunnel

Synopsis

Create a secure tunnel to the remote Apoxy Edge fabric.

apoxy tunnel run [flags]

Options

      --auto                               Automatically create TunnelNode if it doesn't exist.
      --dns-addr string                    Listen address for the DNS proxy. Note that you must configure backplane to use this address as well. (default "127.0.0.1:8053")
      --endpoint-selection string          Endpoint selection strategy: 'latency' (default) or 'random' (default "latency")
      --health-addr string                 Listen address for health endpoint (default: :8080). (default ":8080")
  -h, --help                               help for run
      --insecure-skip-verify               Skip TLS certificate verification.
      --metrics-addr string                Listen address for metrics endpoint (default: :8081). (default ":8081")
      --min-conns int                      Minimum number of connections to maintain. (default 1)
  -m, --mode string                        Mode to run the TunnelNode in. (default "user")
      --no-tui                             Disable TUI interface.
  -p, --pcap string                        Path to the TunnelNode file to create.
      --preserve-default-gw-dsts strings   Preserve default gateway.
      --socks-addr string                  Listen address for SOCKS proxy. (default "localhost:1080")

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy upgrade

Upgrade Apoxy CLI to the latest version

Synopsis

Upgrade Apoxy CLI to the latest version.

apoxy upgrade [flags]

Options

  -h, --help   help for upgrade

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

apoxy version

The version of this CLI

apoxy version [flags]

Options

  -h, --help   help for version

Options inherited from parent commands

      --alsologtostderr   Log to standard error as well as files.
      --config string     Config file (default is $HOME/.apoxy/config.yaml).
      --local             Run in local mode.
      --pprof             Enable pprof HTTP server on :6060.
      --project string    The project ID to use.
  -v, --verbose           Enable verbose output.

CLI reference