CLI Overview

httpeep-cli lets you control HTTPeep from the terminal for local debugging, automation, and CI pipelines.

What you can do with CLI

Manage proxy lifecycle — start, pause, resume, and stop the proxy engine
Query and inspect sessions — list, filter, watch, and delete captured traffic
Create and test rules — upsert, validate, test, import, and export forwarding rules
Send and replay requests — issue HTTP requests through the proxy and replay captured sessions
Record traffic flows — capture sessions into reusable script files
Import external traffic — convert cURL commands, HAR files, or raw HTTP messages
Enter a capture shell — run commands in a terminal session with proxy variables and runtime hooks preloaded
Monitor live traffic — watch real-time traffic in a terminal dashboard
Manage certificates — install and inspect the HTTPS interception root CA

Command guides

CLI Basics

Installation, global flags, output formats, and troubleshooting.

Proxy

Start, pause, resume, stop, and configure the proxy engine.

Sessions

Browse, filter, watch, and delete captured sessions.

Rules

Manage traffic manipulation rules from the terminal.

Request

Send HTTP requests through the proxy with temporary rules.

Replay

Replay captured sessions with retry and temporary overrides.

Record

Record traffic flows into reusable script files.

Certificate

Install and inspect the HTTPS interception root CA.

Shell

Enter a scoped terminal capture environment with httpeep-cli shell or hp shell.

Import

Import traffic from cURL, HAR, and raw HTTP files.

Monitor

Watch live traffic in a real-time terminal dashboard.

Use the bundled agent skill when you want Codex or another Agent Skills-compatible assistant to operate HTTPeep from the terminal. After this repository is public or otherwise accessible to the installer, run:

npx skills add HTTPeep/docs.httpeep.com --skill httpeep-cli

The skill is stored in this docs repository at skills/httpeep-cli and includes safe defaults for JSON output, temporary rules, dry-run cleanup, and certificate/system proxy changes.

Start the proxy and watch traffic

httpeep-cli proxy start --port 8800
httpeep-cli --format json sessions watch

Enter a capture shell

hp shell

This starts or reuses the proxy, prepares the terminal capture environment, and opens a child shell where curl, package managers, Node.js, Python, Ruby, and JVM tools inherit HTTPeep proxy settings.

Send a request and inspect the result

httpeep-cli --format json request --method GET --url "https://httpbin.org/get"
httpeep-cli sessions list --keyword httpbin

Apply a temporary redirect and auto-rollback

httpeep-cli rules run \
  --map-remote "api.example.com=http://127.0.0.1:3000" \
  -- httpeep-cli request --method GET --url "https://api.example.com/users"

Replay a session with retry

httpeep-cli replay --id <session_id> --retry-times 3 --retry-interval-ms 800

All commands support --format json for machine-parseable output. Combine with jq for powerful scripting pipelines.