Skip to content

CLI

ProxAI keeps CLI flags intentionally small. They are for temporary overrides such as local testing or one-off route changes. Long-lived behavior belongs in config.toml.

Terminal window
proxai.exe
Terminal window
proxai \
--config <path> \
--upstream <url> \
--api-key <key> \
--port <port> \
--log-level <level> \
--log-format <human|json> \
--route-override ROUTE.FIELD=VALUE
FlagPurpose
--configPath to a config file (defaults to app dir config.toml)
--upstreamTemporarily override the openai_responses default provider upstream URL for this run
--api-keyTemporarily override the openai_responses default provider API key for this run
--portOverride the local proxy listen port
--log-levelOverride log level
--log-formatOverride log output format (human or json)
--route-overrideTemporarily override a named [[routing.routes]] field

--route-override can be repeated. Supported override fields are request_protocol, match_kind, model_pattern, provider, and upstream_model. Use an empty value to clear optional fields.

Terminal window
proxai --route-override minimax_m3_chat.model_pattern=MiniMax-M3-preview \
--route-override minimax_m3_chat.upstream_model=MiniMax-M3
Terminal window
proxai capture status
proxai capture enable [inbound-request|provider-request|upstream-response|outbound-response]
proxai capture disable [inbound-request|provider-request|upstream-response|outbound-response]

These persist local capture defaults. For one-shot debugging you can also use single-run flags:

Terminal window
proxai --capture-inbound-request
proxai --capture-provider-request
proxai --capture-upstream-response
proxai --capture-outbound-response

For what each capture phase means, see Observability. For default endpoints and other runtime limits, see Defaults and Limits. MCP is a local-only control surface — see Behavior Contract C5 and C6.