Quick Start

Get up and running with APXY in under 2 minutes, then choose whether to keep working in the CLI or the Web UI.

Step 1: Start the proxy

apxy start

On macOS, this automatically:

1. Generates a root CA certificate (first run only)
2. Trusts the CA in your system keychain (prompts for password once)
3. Enables system-wide HTTP/HTTPS proxy
4. Starts the Web UI at http://localhost:8082

All traffic on your machine now flows through APXY — no special configuration needed.

Step 2: Make a request

Open any app, browser, or run a curl command:

curl https://httpbin.org/get

Step 3: Choose how you want to work

Option A — Web UI: Open http://localhost:8082 in your browser.

Use the left menu to move through the main workflows:

• Setup for readiness checks and certificate health
• Capture for live traffic, request details, compose, and diff
• Modify for mocks, filters, redirects, SSL, network conditions, and interceptors
• Analyze for summaries and comparisons
• Operate for environment and day-to-day control actions

Option B — CLI:

# List recent traffic
apxy logs list --limit 10
 
# Search for specific requests
apxy logs search --query "httpbin"

The CLI is the fastest path for logs, rules, request replay, diagnosis, and scriptable workflows.

Step 4: Stop the proxy

Press Ctrl+C in the terminal where the proxy is running, or from another terminal:

apxy stop

This restores your original network settings automatically.

Common start options

# Custom port
apxy start --port 9090
 
# With verbose logging
apxy start --port 8080 --verbose
 
# Skip system proxy (manual -x mode)
apxy start --no-system-proxy
 
# Custom Web UI port
apxy start --web-port 9090
 
# Disable Web UI
apxy start --web-port 0

Next steps

• Proxy Traffic — Learn about traffic capture
• CLI Reference — Learn the current command groups
• Web UI — Learn where each workflow lives in the left menu