Proxyman

https://docs.proxyman.com
Admin
Proxyman is a high-performance HTTP/HTTPS debugging proxy tool for developers to intercept, inspect,...
Tokens:196,044
Snippets:1,922
Trust Score:9.4
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install js-base64 for encoding example

Source: https://docs.proxyman.com/scripting/use-npm-install.md

Install command for the js-base64 example that encodes data. Uses cd and npm install with --prefix and flags.

```bash
cd "$HOME/Library/Application Support/com.proxyman.NSProxy" && npm install --prefix . js-base64 --ignore-scripts --no-audit --no-fund

```

--------------------------------

### Install slugify for slug creation example

Source: https://docs.proxyman.com/scripting/use-npm-install.md

Install command for the slugify example that creates slugs. Uses cd and npm install with --prefix and flags.

```bash
cd "$HOME/Library/Application Support/com.proxyman.NSProxy" && npm install --prefix . slugify --ignore-scripts --no-audit --no-fund

```

--------------------------------

### Install dayjs for date formatting example

Source: https://docs.proxyman.com/scripting/use-npm-install.md

Install command for the dayjs example that formats a date. Uses cd and npm install with --prefix and flags.

```bash
cd "$HOME/Library/Application Support/com.proxyman.NSProxy" && npm install --prefix . dayjs --ignore-scripts --no-audit --no-fund

```

--------------------------------

### Install he for HTML entity decoding example

Source: https://docs.proxyman.com/scripting/use-npm-install.md

Install command for the he example that decodes HTML entities. Uses cd and npm install with --prefix and flags.

```bash
cd "$HOME/Library/Application Support/com.proxyman.NSProxy" && npm install --prefix . he --ignore-scripts --no-audit --no-fund

```

--------------------------------

### Install validator for input validation example

Source: https://docs.proxyman.com/scripting/use-npm-install.md

Install command for the validator example that validates input. Uses cd and npm install with --prefix and flags.

```bash
cd "$HOME/Library/Application Support/com.proxyman.NSProxy" && npm install --prefix . validator --ignore-scripts --no-audit --no-fund

```

--------------------------------

### Install lodash for text normalization example

Source: https://docs.proxyman.com/scripting/use-npm-install.md

Install command for the lodash example that normalizes text. Uses cd and npm install with --prefix and flags.

```bash
cd "$HOME/Library/Application Support/com.proxyman.NSProxy" && npm install --prefix . lodash --ignore-scripts --no-audit --no-fund

```

--------------------------------

### Start NodeJS server with npm start

Source: https://docs.proxyman.com/debug-devices/nodejs

Run your NodeJS backend server or scripts in the terminal launched by Proxyman's Automatic Setup to capture traffic automatically.

```bash
$ npm start
```

--------------------------------

### Run Go server with automatic Proxyman setup

Source: https://docs.proxyman.com/debug-devices/golang.md

Command to start a Go backend server or script in the pre-configured terminal opened by Proxyman's Automatic Setup. This enables automatic traffic capture without manual proxy configuration.

```bash
$ go run main.go
```

--------------------------------

### network-extension enable

Source: https://docs.proxyman.com/command-line.md

Enables capture, installing the extension if necessary. Starts capture and turns the helper-based system proxy off.

```APIDOC
## network-extension enable

### Description
Enables capture, installing the extension if necessary. Starts capture and turns the helper-based system proxy off.

### Command
`/Applications/Proxyman.app/Contents/MacOS/proxyman-cli network-extension enable`

### Notes
- Requires Proxyman PRO.
- The system proxy cannot be enabled while Network Extension capture is on.
- macOS may ask for approval or a restart.
```

--------------------------------

### Install OpenConnect via Homebrew

Source: https://docs.proxyman.com/troubleshooting/proxyman-does-not-work-with-vpn-apps.md

Install OpenConnect using Homebrew, a prerequisite for the Pulse Secure and Global Protect VPN solution.

```bash
brew install openconnect
```

--------------------------------

### Start Docker with docker-compose.proxyman.yml

Source: https://docs.proxyman.com/debug-devices/docker

Run this command to start Docker with the proxy configuration file. It combines the base docker-compose.yml with the proxy override file.

```bash
docker-compose -f docker-compose.yml -f docker-compose.proxyman.yml up -d
```

--------------------------------

### Install all Proxyman skills with npx

Source: https://docs.proxyman.com/skill-md.md

Installs all Proxyman skills from the GitHub repository using the npx skills add command.

```bash
npx skills add ProxymanApp/proxyman-SKILL.md/skills
```

--------------------------------

### Install adb with Homebrew

Source: https://docs.proxyman.com/debug-devices/android-device/automatic-script-for-android-emulator.md

Install the Android platform tools (adb) using Homebrew. Required before using Proxyman with Android emulators.

```bash
brew install android-platform-tools
```

--------------------------------

### axios GET Request (Windows/Linux)

Source: https://docs.proxyman.com/scripting/async-await-request.md

Example of using the built-in axios library on Windows/Linux to make a GET request. Uses try/catch to handle errors and logs the response or error.

```javascript
async function getUser() {
  try {
    const response = await axios.get('/user?ID=12345');
    console.log(response);
  } catch (error) {
    console.error(error);
  }
}
```

--------------------------------

### Usage help for install_certificate_android_emulator.sh (Proxyman 51.9.0+)

Source: https://docs.proxyman.com/debug-devices/android-device/automatic-script-for-android-emulator.md

Usage and options for the script, including modes (all, proxy, revertProxy, certificate) and required/optional options. Available for Proxyman 51.9.0 or later.

```bash
Usage: /Applications/Proxyman.app/Contents/Frameworks/ProxymanCore.framework/Resources/install_certificate_android_emulator.sh -m <mode> [options]

Modes:
  all             Set proxy and install certificate
  proxy           Set proxy only
  revertProxy     Revert proxy settings only
  certificate     Install certificate only

Required Options based on Mode:
  -m, --mode <mode>              : Operation mode (all, proxy, revertProxy, certificate)
  -i, --ip <ip_address>          : IP address (required for all, proxy, certificate)
  -p, --port <port_number>       : Port number (required for all, proxy, certificate)
  -c, --cert <path_to_cert.pem>  : Path to Proxyman certificate (required for all, certificate)

Optional Options:
  --include-physical            : Include physical devices (default: only emulators)
  -h, --help                    : Show this help message
```

--------------------------------

### HTTP package proxy configuration

Source: https://docs.proxyman.com/debug-devices/flutter.md

Configures the http package's IOClient to use Proxyman as a proxy. Uses the same HttpClient setup as the Dart HttpClient example, then passes it to IOClient. Replace <YOUR_LOCAL_IP> with your computer's IP when using Android physical devices.

```dart
// Make sure to replace <YOUR_LOCAL_IP> with 
// the external IP of your computer if you're using Android. 
// You can get the IP in the Android Setup Guide window
String proxy = Platform.isAndroid ? '<YOUR_LOCAL_IP>:9090' : 'localhost:9090';

// Create a new HttpClient instance.
HttpClient httpClient = HttpClient();

// Hook into the findProxy callback to set
// the client's proxy.
httpClient.findProxy = (uri) {
  return "PROXY $proxy;";
};

// This is a workaround to allow Proxyman to receive
// SSL payloads when your app is running on Android.
httpClient.badCertificateCallback = (cert, host, port) => true;

// Pass your newly instantiated HttpClient to http.IOClient.
IOClient myClient = IOClient(httpClient);

// Make your request as normal.
final response = myClient.get('/my-url');
```

--------------------------------

### Create rules for all tools

Source: https://docs.proxyman.com/command-line.md

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.

```bash
/Applications/Proxyman.app/Contents/MacOS/proxyman-cli rules block-list create https://ads.example.com/*
/Applications/Proxyman.app/Contents/MacOS/proxyman-cli rules allow-list create https://api.example.com/*
/Applications/Proxyman.app/Contents/MacOS/proxyman-cli rules ssl-proxying create '*.example.com' --list include
/Applications/Proxyman.app/Contents/MacOS/proxyman-cli rules map-local create https://api.example.com/* --path ./response.json
/Applications/Proxyman.app/Contents/MacOS/proxyman-cli rules map-remote create https://old.example.com/* https://new.example.com/
/Applications/Proxyman.app/Contents/MacOS/proxyman-cli rules breakpoint create https://api.example.com/* --phase both
/Applications/Proxyman.app/Contents/MacOS/proxyman-cli rules scripting create https://api.example.com/* --script-file ./rule.js
/Applications/Proxyman.app/Contents/MacOS/proxyman-cli rules network-condition create --profile 3g
/Applications/Proxyman.app/Contents/MacOS/proxyman-cli rules reverse-proxy create https://upstream.example.com --local-port 8080
/Applications/Proxyman.app/Contents/MacOS/proxyman-cli rules protobuf create https://api.example.com/* --request-type package.Request
/Applications/Proxyman.app/Contents/MacOS/proxyman-cli rules dns-spoofing create example.com 127.0.0.1
```

--------------------------------

### Configure reqwest client with Proxyman proxy and disabled SSL verification

Source: https://docs.proxyman.com/debug-devices/rust

Sets the proxy to http://localhost:9090 and disables SSL verification to allow Proxyman to capture traffic. Uses reqwest::Client::builder() with danger_accept_invalid_certs(true) and proxy(). The example sends a GET request to https://httpbin.org/get and prints the response or failure status.

```rust
use anyhow::Result;
use reqwest::Url;

#[tokio::main]
async fn main() -> Result<()> {
    let proxy_url = Url::parse("http://localhost:9090")?;
    let client = reqwest::Client::builder()
        .danger_accept_invalid_certs(true) // trust self-signed certificate
        .proxy(reqwest::Proxy::https(proxy_url)?) // Proxy to Proxyman
        .build()?;
    let response = client.get("https://httpbin.org/get").send().await?;

    if response.status().is_success() {
        let body = response.text().await?;
        println!("Response Text: {}", body);
    } else {
        println!("Request failed with status: {}", response.status());
    }

    Ok(())
}
```

--------------------------------

### Check CLI syntax with --help

Source: https://docs.proxyman.com/command-line.md

Use these commands to display the help and syntax for the http-version and network-extension command groups. The help output is plain text, not JSON.

```bash
/Applications/Proxyman.app/Contents/MacOS/proxyman-cli http-version --help
/Applications/Proxyman.app/Contents/MacOS/proxyman-cli network-extension --help
```

--------------------------------

### Install dayjs with npm install --prefix

Source: https://docs.proxyman.com/scripting/use-npm-install

Installs the dayjs package into Proxyman's Application Support folder. Uses --ignore-scripts, --no-audit, and --no-fund flags. After installation, the package is available in the node_modules folder.

```bash
$ cd "$HOME/Library/Application Support/com.proxyman.NSProxy"
$ npm install --prefix . dayjs --ignore-scripts --no-audit --no-fund
```

--------------------------------

### Install Proxyman via Homebrew Cask

Source: https://docs.proxyman.com/readme.md

Use this command to install the Proxyman macOS app using Homebrew Cask. Requires Homebrew to be installed on your system.

```bash
$ brew install --cask proxyman
```

--------------------------------

### Install individual Proxyman skills with npx

Source: https://docs.proxyman.com/skill-md.md

Installs a single Proxyman skill by specifying the skill name with the --skill flag. Each command installs one skill.

```bash
npx skills add ProxymanApp/proxyman-SKILL.md --skill proxyman-download-setup
npx skills add ProxymanApp/proxyman-SKILL.md --skill proxyman-app-settings
npx skills add ProxymanApp/proxyman-SKILL.md --skill proxyman-certificates-recovery
npx skills add ProxymanApp/proxyman-SKILL.md --skill proxyman-mcp-setup
npx skills add ProxymanApp/proxyman-SKILL.md --skill proxyman-traffic-debugging
npx skills add ProxymanApp/proxyman-SKILL.md --skill proxyman-debugging-tools
npx skills add ProxymanApp/proxyman-SKILL.md --skill proxyman-license-management
npx skills add ProxymanApp/proxyman-SKILL.md --skill proxyman-cli
npx skills add ProxymanApp/proxyman-SKILL.md --skill proxyman-https-capture
```

--------------------------------

### Sample node-fetch code with global-agent

Source: https://docs.proxyman.com/debug-devices/nodejs.md

Complete example showing how to use node-fetch with global-agent to capture traffic. It fetches data from httpbin.org and logs the response.

```javascript
import fetch from 'node-fetch';

// Setup global-agent
import { bootstrap } from 'global-agent';
bootstrap();
process.env['NODE_TLS_REJECT_UNAUTHORIZED'] = '0';

// fetch the data
const response = await fetch('https://httpbin.org/get?id=123');
const data = await response.json();

// Done
console.log(data);
```

--------------------------------

### Install adb via Chocolatey

Source: https://docs.proxyman.com/proxyman-windows/wsl.md

Run this command in PowerShell as administrator to install Android Debug Bridge (adb) using Chocolatey. Verify that adb is successfully installed with no errors.

```powershell
choco install adb -y
```
Tokens:
Raw