Skip to Content

apxy proxy

Start, stop, and monitor the APXY proxy server.

apxy start

Start the local APXY proxy.

On macOS this command automatically:

  1. Generates the CA certificate (if first run)
  2. Trusts the CA in your system keychain (prompts for password)
  3. Enables system-wide HTTP/HTTPS proxy
  4. Intercepts HTTPS traffic and persists captured requests to traffic logs

HTTPS handling tiers

TierBehavior
TUNNELCert-pinned domains (--bypass-domains) are tunneled as-is
SKIPNon-enabled domains are forwarded without MITM body capture
DEEPDomains with SSL proxying enabled (--ssl-domains or ssl enable) are saved with full request/response bodies

Synopsis

apxy start [flags]

Examples

# Standard startup apxy start # Start on alternate ports apxy start --port 9090 --control-port 9091 --web-port 9092 # Start without modifying the system proxy apxy start --no-system-proxy # Deep inspect specific domains from startup apxy start --ssl-domains "api.example.com,*.stripe.com" # Bypass cert-pinned apps apxy start --bypass-domains "*.openai.com,*.local" # Intercept all HTTPS traffic apxy start --mitm-all # Chain through a corporate proxy apxy start --upstream-proxy "http://proxy.corp.com:3128" # Project-scoped isolation apxy start --project-dir ./my-project

Options

FlagTypeDefaultDescription
--auto-validate-falseAutomatically validate traffic against imported schemas
--bypass-domainsstring-Comma-separated domains to force tunnel even with --mitm-all
--cert-dirstring~/.apxy/certsCertificate directory
--control-portintproxy port + 1Control API port
--max-bodyint1048576Max body capture size in bytes
--mitm-all-falseMITM all HTTPS traffic (captures all bodies)
--network-servicestringauto-detectedNetwork service to configure
--no-mdns-falseDon’t advertise proxy via mDNS/Bonjour
--no-system-proxy-falseDon’t configure system proxy (use -x manually)
--portint8080Proxy port
--project-dirstring-Project directory for scoped isolation (uses .apxy/ subdir)
--ssl-domainsstring-Comma-separated domains to enable SSL proxying for
--upstream-proxystring-Upstream proxy URL for chaining
--web-portintproxy port + 2Web UI port (0 to disable)

apxy stop

Stop the running APXY proxy process and disable any system proxy settings it configured.

Synopsis

apxy stop [flags]

Examples

apxy stop

apxy status

Check whether the local APXY proxy is running and display its current state, including active rules and traffic stats.

Synopsis

apxy status [flags]

Examples

apxy status apxy status --format toon

Options

FlagTypeDefaultDescription
--formatstringjsonOutput format: json or toon
--portint8080Proxy port (for status reporting)

apxy proxy browser

Launch a browser with proxy settings and CA certificate pre-installed. The browser uses an isolated temp profile so it won’t affect your normal browsing.

Synopsis

apxy proxy browser [url] [flags]

Examples

apxy proxy browser apxy proxy browser https://api.example.com apxy proxy browser --browser firefox https://example.com

Options

FlagTypeDefaultDescription
--browserstringchromeBrowser to launch: chrome or firefox
--cert-dirstring~/.apxy/certsCertificate directory
--portint8080Proxy port

apxy env

Generate environment variables that configure terminal processes (Go, Node.js, Python, Ruby, cURL) to route traffic through the APXY proxy.

This solves the problem that many tools executed from the terminal don’t respect macOS system proxy settings. By setting HTTP_PROXY, HTTPS_PROXY, and language-specific CA trust env vars, all HTTP clients in the current session will automatically route through APXY.

Synopsis

apxy env [flags]

Examples

# Inject into current shell eval $(apxy env) # Open a new terminal with env pre-configured apxy env --open # Save as a reusable script apxy env --script /tmp/apxy_env.sh source /tmp/apxy_env.sh # Target a specific language eval $(apxy env --lang node) # Skip CA cert trust (proxy routing only) eval $(apxy env --no-cert)

Options

FlagTypeDefaultDescription
--bypass-domainsstring-Additional domains to bypass proxy (comma-separated)
--cert-dirstring~/.apxy/certsCA certificate directory
--langstringallTarget language: all, go, node, python, ruby, curl
--no-cert-falseSkip CA cert trust env vars (proxy routing only)
--open-falseOpen a new terminal with env vars pre-configured
--portint8080Proxy port
--scriptstring-Write env setup script to file instead of stdout

Inherited Options

FlagTypeDefaultDescription
--configstring./configs/default.yamlConfig file path
--error-formatstringtextError output format: text or json
--help-formatstringdefaultHelp output format: default or agent
--verbose-falseEnable verbose output
Last updated on