CLI reference · JoesProxy

Why is a response body missing?

Set up the CLI. Run docs search for “missing body”, then docs read for the inspector’s context section. Neither step starts the proxy or reads a capture.

New terminal? Start with version to identify the executable, then doctor to check the connection. You can read the bundled docs offline. To inspect live traffic, enroll the CLI on the capture Mac.

Alphabetical index by exact name

Compute on the capture Mac

joesproxyctl capture calculate command: Check the completion status, selected source and exact numeric summary. For prices 0.1 and 0.2 the expected sum is the decimal string "0.3".
joesproxyctl efficiency report command: For the example file the candidate returns 192 fewer response bytes, with no difference in calls or analyses. No provider usage was supplied.

Run a controlled media test

joesproxyctl hls fixture apply-start command: After local review, inspect the resulting run ID and fixture status before using the stream.
joesproxyctl hls fixture prepare-start command: Prepare a baseline test stream and inspect the returned proposal. Preparing is not serving.
joesproxyctl hls fixture stop command: Stop the owned fixture run and unregister its local fixture origin.
joesproxyctl hls fixture window-preview command: Inspect the publication window at a particular elapsed time without fetching a segment.
joesproxyctl hls substitute profiles command: Read available test-stream profiles before choosing a substitution.
joesproxyctl hls substitute status command: Inspect owned substitutions and reported hits. A hit is not proof the player recovered.
joesproxyctl hls substitute stop command: End an owned stream substitution so matching requests can use the upstream source again.

Test network conditions

joesproxyctl throttle apply command: Apply the reviewed proposal and repeat the same app action, then compare transfer timing.
joesproxyctl throttle disable command: Propose and apply disabling the throttle. Verify the next comparable request without pacing.
joesproxyctl throttle prepare command: Prepare a paced-network comparison for your test device. Inspect the proposed preset before applying it.

Inspect a capture

joesproxyctl bookmark get command: Read one saved bookmark. Its historical response is not the current origin response.
joesproxyctl bookmark list command: Find a bounded page of saved bookmarks. Bookmark identity is different from capture session identity.
joesproxyctl effect bundle list command: List effect bundles retained for this client. A retained bundle does not mean its effects are active.
joesproxyctl effect bundle stop command: Deactivate the selected bundle. Re-run one matching request to confirm normal behavior.
joesproxyctl rule get command: Inspect a single rule to identify its intended match. Check a new request for an actual hit.
joesproxyctl rule list command: Inspect the saved rule list before diagnosing an unexpected response.
joesproxyctl session show command: Inspect one captured request rather than exporting the whole session list.
joesproxyctl sessions list command: List a bounded page of captured requests. Use an actual returned session identifier in subsequent reads.
joesproxyctl sessions search command: Find a short page of matching GET requests without requesting response bodies.

Check the workspace

joesproxyctl approvals list command: Inspect approvals visible to this client. Listing a request does not grant it.
joesproxyctl auth login command: Enroll your own CLI from an interactive terminal and review the request on the Mac.
joesproxyctl auth logout command: End this CLI enrollment session after checking outstanding test effects.
joesproxyctl auth status command: Check enrollment state before trying a live command.
joesproxyctl capture status command: Inspect current capture limits and admission pressure without reading any response bodies.
joesproxyctl cleanup status command: Review client-owned effects and whether the session can finish cleanly. This check does not stop anything.
joesproxyctl device list command: List devices seen by this capture. Correlate the intended device with a fresh app action.
joesproxyctl doctor command: Check CLI connectivity and local prerequisites before examining capture traffic.
joesproxyctl toolset status command: Inspect the connected client’s discovery selection. A selected toolset does not authorize changing traffic.
joesproxyctl version command: Identify the installed CLI before comparing its help to another machine.

Find help

joesproxyctl docs list command: List installed documentation topics. The JSON result contains entries with topic IDs.
joesproxyctl docs read command: Read the section describing tunnels, truncated recordings and absent response bodies. JSON includes result.entries and the selected section.
joesproxyctl docs search command: Find workflow-evidence among the matching topics. Its excerpt is documentation, not a diagnosis of a live capture.
joesproxyctl help command: List the supported command syntax. Use the help subcommand, not --help.
joesproxyctl setup guide command: Read the portable setup guide. The result contains guide text, not live endpoint credentials.

Investigate media

joesproxyctl hls fixture capabilities command: Discover fixture routing and availability before picking a test stream.
joesproxyctl hls fixture profiles command: List the available synthetic profiles and select a baseline to compare against a fault.
joesproxyctl hls fixture status command: List owned fixture runs. With a specific run ID, check that experiment rather than all runs.
joesproxyctl media manifest command: Inspect the playlist or manifest structure captured in a request.
joesproxyctl media readiness command: See which media investigations are available for this captured response.
joesproxyctl media related command: Find related media requests in the capture. Their presence is network evidence, not proof of playback.
joesproxyctl media summary command: Read the available media metadata for a selected session.
joesproxyctl operation status command: Check progress of a previously started media operation. Request the full result only once it is ready.