Skip to Content
Introduction

APXY Documentation

APXY is a local network debugging and API mocking proxy. Capture HTTP/HTTPS traffic, inspect failures, mock APIs, replay requests, and compare results from the CLI or Web UI.

What is APXY?

APXY runs as a local proxy between your machine and the internet. Start it once, then use whichever interface fits your workflow:

  • CLI — fast inspection, automation, CI pipelines, and AI coding agent workflows
  • Web UI — live traffic review, visual rule management, and guided setup

Key Features

  • Traffic Capture — Inspect HTTP/HTTPS traffic with full request and response details
  • Task-Oriented CLI — Start the proxy, inspect traffic, manage rules, and troubleshoot from grouped command families
  • Workflow-Based Web UI — Move through Setup, Capture, Modify, Analyze, and Operate from the left menu
  • Mock Rules — Return controlled responses for chosen requests
  • SSL Proxying — Control HTTPS interception per host
  • Traffic Filtering — Allow or block traffic by host pattern
  • URL Redirects — Send requests to a different backend without changing the client
  • Network Conditions — Simulate latency and throttling during testing
  • Interceptors — Modify requests or responses with rule-based transforms
  • Export & Replay — Re-run captured traffic or export it for external tools
  • API Diagnosis — Run request batches and diagnostics from the CLI

Quick Install

# Download the binary for your platform
chmod +x apxy-darwin-arm64
mv apxy-darwin-arm64 apxy
sudo mv apxy /usr/local/bin/
 
# Start the proxy
apxy start
 
# That's it! All traffic now flows through APXY
curl https://httpbin.org/get

Open http://localhost:8082 to work in the Web UI.

Choose your workflow

Use the CLI when you want:

  • fast terminal-based inspection
  • repeatable commands in scripts or CI
  • direct access to logs, rules, and diagnostics

Start with Quick Start and CLI Reference.

Use the Web UI when you want:

  • a live traffic table and detail viewer
  • visual rule management for filters, redirects, SSL, and mocks
  • guided setup checks from the Setup page

Start with Web UI and Proxy Traffic.

Next Steps

  • Installation — Download and set up APXY
  • Quick Start — Your first proxy session in 2 minutes
  • CLI Reference — Learn the current command groups
  • Web UI — Learn the current left-menu workflow
  • Templates  — Download reusable mock kits for common APIs
  • Examples  — Follow concrete workflows for debugging and AI agent usage
Last updated on
Installation