apxy setup

Configure certificates, SSL interception, mobile devices, and project settings.

apxy init

Initialize a project-scoped APXY workspace. Creates a .apxy/ directory with isolated configuration, database, certificates, and mock rules.

After running init, start with apxy start --project-dir .


apxy init [flags]

apxy certs

Generate, inspect, and trust the APXY root CA certificate.

apxy certs generate

Generate a new root Certificate Authority (CA) certificate and private key for HTTPS interception.


apxy certs generate [flags]

Flag	Type	Default	Description
`--cert-dir`	`string`	`~/.apxy/certs`	Certificate directory

apxy certs info

Show subject, issuer, serial number, validity dates, and key usage for the APXY root CA certificate.


apxy certs info [flags]

Flag	Type	Default	Description
`--cert-dir`	`string`	`~/.apxy/certs`	Certificate directory

apxy certs trust

Install the APXY root CA certificate into the system trust store (may require sudo on macOS).


apxy certs trust [flags]

Flag	Type	Default	Description
`--cert-dir`	`string`	`~/.apxy/certs`	Certificate directory

apxy certs custom

Manage custom Certificate Authorities bound to domain patterns. Paid feature.

apxy certs custom add

Add a custom CA for a domain pattern.


apxy certs custom add [flags]

Examples:


apxy certs custom add --domain "*.example.com" \
  --cert ./ca.pem --key ./ca-key.pem

Flag	Type	Default	Description
`--cert`	`string`	-	Path to CA certificate file (.crt or .pem) (required)
`--domain`	`string`	-	Domain pattern (e.g. `.example.com`) (required)*
`--key`	`string`	-	Path to CA private key file (.key or .pem) (required)
`--label`	`string`	-	Optional label for the CA
`--no-trust`	-	`false`	Skip installing the CA in the system trust store

apxy certs custom list

List all custom CAs.


apxy certs custom list [flags]

Flag	Type	Default	Description
`--format`	`string`	`json`	Output format: `json` or `toon`
`-q`, `--quiet`	-	`false`	Output only IDs, one per line

apxy certs custom info

Show detailed information about a custom CA.


apxy certs custom info [flags]

Flag	Type	Default	Description
`--domain`	`string`	-	Domain pattern (required)

apxy certs custom remove

Remove a custom CA by domain pattern or all custom CAs with --all.


apxy certs custom remove [flags]

Flag	Type	Default	Description
`--all`	-	`false`	Apply to all resources
`--domain`	`string`	-	Domain pattern
`--dry-run`	-	`false`	Preview without executing

apxy certs custom trust

Install a previously added custom CA certificate into the system trust store.


apxy certs custom trust [flags]

Flag	Type	Default	Description
`--domain`	`string`	-	Domain pattern (required)

See SSL Proxying — Custom CAs for details.

apxy ssl

Manage per-domain HTTPS interception rules for the running proxy.

apxy ssl enable

Enable HTTPS interception for a specific domain, allowing the proxy to decrypt and inspect TLS traffic.


apxy ssl enable [flags]

Flag	Type	Default	Description
`--control-url`	`string`	`http://localhost:8081`	Control API URL
`--domain`	`string`	-	Domain to enable (required)

apxy ssl disable

Disable HTTPS interception for a specific domain or all domains. Traffic to disabled domains will pass through as opaque TLS.


apxy ssl disable [flags]

Flag	Type	Default	Description
`--all`	-	`false`	Apply to all resources
`--control-url`	`string`	`http://localhost:8081`	Control API URL
`--domain`	`string`	-	Domain to disable
`--dry-run`	-	`false`	Preview without executing

apxy ssl list

List all domains with HTTPS interception enabled.


apxy ssl list [flags]

Flag	Type	Default	Description
`--control-url`	`string`	`http://localhost:8081`	Control API URL
`--format`	`string`	`json`	Output format: `json` or `toon`
`-q`, `--quiet`	-	`false`	Output only IDs, one per line

See SSL Proxying for details.

apxy setup mobile

Get mobile device setup instructions.

apxy setup mobile setup

Print step-by-step instructions for connecting mobile devices to the APXY proxy. Auto-detects host LAN IP.


apxy setup mobile setup [flags]

Examples:


apxy setup mobile setup --platform ios
apxy setup mobile setup --platform android
apxy setup mobile setup --qr

Flag	Type	Default	Description
`--platform`	`string`	-	Target platform: `ios`, `android`, or show all
`--port`	`int`	`8080`	Proxy port
`--qr`	-	`false`	Display QR code for mobile setup page

See Mobile Setup for details.

apxy setup settings

Export and import APXY configuration. Paid feature.

apxy setup settings export

Export all current APXY settings as JSON to stdout or to a file.


apxy setup settings export [flags]

Flag	Type	Default	Description
`--file`	`string`	stdout	Output file path

apxy setup settings import

Import APXY settings from a previously exported JSON file.

Warning: This overwrites all current settings.


apxy setup settings import [flags]

Flag	Type	Default	Description
`--dry-run`	-	`false`	Preview without executing
`--file`	`string`	-	Configuration file to import (required)

See Settings Management for details.

Inherited Options

Flag	Type	Default	Description
`--config`	`string`	`./configs/default.yaml`	Config file path
`--error-format`	`string`	`text`	Error output format: `text` or `json`
`--help-format`	`string`	`default`	Help output format: `default` or `agent`
`--verbose`	-	`false`	Enable verbose output