CLI Reference

APXY — HTTPS network debugging and API mocking tool, optimized for AI agents.

Command tree


apxy
├── proxy     → start, stop, status, browser, env
├── traffic   → logs, filter, recording, sql, devices
├── rules     → mock, redirect, interceptor, breakpoint, caching, network, script
├── setup     → certs, init, ssl, mobile, settings
├── tools     → request, protobuf, db
├── schema    → import, list, show, delete, validate, validate-recent
├── license   → activate, status, deactivate
└── config    → export, import

Common defaults

Setting	Default
Proxy port	`8080`
Control API port	proxy port + 1 (`8081`)
Web UI port	proxy port + 2 (`8082`, `0` to disable)
Config file	`./configs/default.yaml`
Certificate directory	`~/.apxy/certs`

Global options

These flags are available on every command:

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

Environment variables

Variable	Description	Default
`APXY_CONTROL_URL`	URL of the control API	`http://localhost:8081`
`APXY_DB`	Path to the local traffic database	`./data/apxy.db`

Picking the right interface

Use the CLI when you want:

Terminal-first inspection and troubleshooting
Scriptable commands for repeatable workflows
Precise rule or environment changes

Use the Web UI when you want:

Live visual traffic browsing
Guided setup diagnostics
Visual editing of mocks, filters, redirects, SSL, and network rules