Ctrlk
HomepageDownload
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Command-line

Interact with Proxyman via Command Line.

Proxyman provides a useful command-line tool to enhance your onboarding experience ✅.

You can access the tool at /Applications/Proxyman.app/Contents/MacOS/proxyman-cli

1. Export Proxyman config

Export all debugging tools rules, such as SSL Proxying List, Breakpoint, Map Local, Scripting, Block List, Allow List, Reverse Proxy, and Network Conditions.

$ /Applications/Proxyman.app/Contents/MacOS/proxyman-cli export -h

OVERVIEW: Export all debugging tools rules (Breakpoint, SSL Pinning, Map Local, Map
Remote, Scripting, etc).

USAGE: proxyman-cli export [--mode <mode>] --output <output>

OPTIONS:
  -m, --mode <mode>       Export Mode (all = "All debugging tools's rules", enabledRules
                          = "Only enabled rules"). (default: all)
  -o, --output <output>   A Output file to save the config to.
  --version               Show the version.
  -h, --help              Show help information.

By default, the export command will export all rules. To exclude particular rules, please uncheck the "Enabled" column in each debugging tool and use the -m enabledRules

For example:

  • Export all debugging tool rules:

$ /Applications/Proxyman.app/Contents/MacOS/proxyman-cli export -o ~/Desktop/data.json

  • Only export enabled rules:

$ /Applications/Proxyman.app/Contents/MacOS/proxyman-cli export -m enabledRules -o ~/Desktop/data.json

2. Import Proxyman config

Import Proxyman debugging tools rules that you have exported by the export command.

By default, new imported rules will be appended to the existing debugging rules. To override all rules, let use -m override

For example:

  • Import all debugging rules by appending them:

  • Import, but override all my existing rules:

3. Activate/Unlink License

Please check out the command for activating and unlinking a license.

License

4. Toggle HTTP System Proxy

From Proxyman 4.8.0 and later, we can toggle the Proxy System by command line. It's useful for Raycast Extension

Reference: https://github.com/ProxymanApp/Proxyman/issues/1626#issuecomment-1545862020

5. Clear Session

  • We can clear the current Session from the command line. Available for Proxyman 4.12.0 and later.

6. Toggle Debugging Tools

  • Toggle Breakpoint, Map Local, and Scripting Tool by command line. Available for Proxyman 4.12.0 and later.

7. Install the Proxy Helper Tool by command line

From macOS 4.12.0 or later, you can install the Helper Tool without GUI.

8. Export Proxyman Log

Proxyman macOS v5.11.0+ now supports:

  • Export all (ProxymanSession Format)

  • Export certain domains (Only Host, no scheme, no port, no paths, and no Query)

From Proxyman macOS 5.20.0+, we can export with Raw or HAR format.

  • Export All - RAW Request/Response Format

  • Export All - HAR Format

  • Export certain domains - RAW Request/Response Format

  • Export certain domains - HAR Format

From macOS 6.2.0+, we can export with a flag --since <last_flow_id> to only export from this flow ID.

9. Import Custom Root Certificate

  • ✅ Import Custom p12 Root Certificate to Proxyman

  • Automatically Trust the certificate in System Keychain (sudo required)

  • Available from Proxyman macOS 5.15.0 or later

Install and trust

Install but not trust (you might need to trust it manually in the Keychain)

10. Export Current IP and Port

  • Available from macOS 7.6.0 or later

  • Get the current Listening IP & Port in JSON format

11. Add, Remove, Replace the Custom certificates (Client and Server)

  • Available on macOS 6.10.0 or later ✅

  • Support the P12 certificate with a password

12. External Proxy CLI

  • Proxyman macOS6.12.0 or later ✅

Enable

Enable External Proxy without changing the saved configuration:

  • Enable and configure a proxy mode:

Disable

Disable the entire External Proxy feature:

  • Disable only one proxy mode:

13. CRUD for all debugging tools

Only available on Proxyman macOS 6.14.0 or later

Supported tools

block-list, allow-list, ssl-proxying, map-local, map-remote, breakpoint, scripting, network-condition, reverse-proxy, protobuf, and dns-spoofing.

Common commands

Replace <tool> with one of the supported tools and <id> with a rule ID from list or get.

enable <id> also turns on its tool when needed. Turning off a tool keeps each rule's own enabled setting. Updates change only the fields you send; delete removes the rule right away.

Create a rule

These are the smallest create commands. Optional flags let you set more fields. Run /Applications/Proxyman.app/Contents/MacOS/proxyman-cli rules <tool> create --help to see them.

Common rule flags include --name, --enabled true|false, --method, --match wildcard|regex, and --include-subpaths true|false when the tool supports them. Names are optional. If you omit an optional value, Proxyman uses that tool's normal default.

JSON input

For create and update, use --input <file> to send a JSON object. Use --input - to read JSON from standard input. Do not mix --input with field flags.

When Proxyman is closed, the command returns JSON with ok: false and the app_not_running error code. Input errors use exit code 2; other errors use exit code 1.

PreviousRaycastNextMCP

Last updated

Was this helpful?