joesproxyctl docs read

Read the section describing tunnels, truncated recordings and absent response bodies. JSON includes result.entries and the selected section.

command · Offline

Before you start

Start with a topic ID returned by the installed CLI. Add the matching section ID for a shorter answer. The text comes from local files, even when the topic describes a live command.

Find the bundled CLI on your Mac

Command

joesproxyctl docs read --topic requestInspector --section context --format json

--format markdown produces readable text; --format json returns a structured documentation result. These are offline topics, not live session data.

Checked with the bundled CLI using offline documentation.

What to look for

Read the section describing tunnels, truncated recordings and absent response bodies. JSON includes result.entries and the selected section.

If the result is unexpected

If the section is missing, omit --section to read the topic and inspect the available sections.

Effects and cleanup

This reads installed guidance. There is no session or traffic rule to clean up.

Browse all CLI reference entries →