ProxymanApp / Proxyman

Modern. Native. Delightful Web Debugging Proxy for macOS, iOS, and Android ⚡️
https://proxyman.io
5.51k stars 181 forks source link

Import/Export by CLI to enhance the onboarding process experience #1146

Open NghiaTranUIT opened 2 years ago

NghiaTranUIT commented 2 years ago

Description

For the context, when onboarding a new teammate, it's cumbersome to manually export/import each debugging tool's rules (e.g. SSL Proxying, Breakpoint, Map Local, Scripting, ...) via GUI.

To enhance the onboarding process in a mid-size team, one of our customers suggest that it'd be great if they can import/export all settings by CLI.

Thus, the new teammates just need to run $./proxyman_cli import <setting_file> and it's ready to work ✅

Acceptance Criteria

NghiaTranUIT commented 2 years ago

Done with this Beta build: https://proxyman.s3.us-east-2.amazonaws.com/beta/Proxyman_3.1.0_Import_Export_command_line.dmg

Import Export Proxyman Config by CLI

Import

/Applications/Proxyman.app/Contents/MacOS/proxyman-cli import -h
OVERVIEW: Import config to Proxyman.

USAGE: proxyman-cli import [--mode <mode>] --input <input>

OPTIONS:
  -m, --mode <mode>       Import Mode (append = "Append to the existing rules"),
                          override = "Import and Replace all existing rules". (default:
                          append)
  -i, --input <input>     A input file to import.
  --version               Show the version.
  -h, --help              Show help information.

Export

/Applications/Proxyman.app/Contents/MacOS/proxyman-cli export -h
OVERVIEW: Export all debugging tools's 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.

Ref: https://docs.proxyman.io/command-line