Documentation

Get Started withGraphQL Grab

The missing GraphQL DevTool. Capture any GraphQL API in one command.

30 second setup
No schema required
Direct Postman export

Installation

Install GraphQL Grab globally using your preferred package manager:

npm
npm install -g graphql-grab
yarn
yarn global add graphql-grab
pnpm
pnpm add -g graphql-grab

Verify the installation:

gqlgrab --version

Authentication & License

GraphQL Grab offers a free tier with basic features. Unlock Pro features like unlimited captures and all export formats with a license.

1

Get Your License Key

Open the browser to get your license key:

gqlgrab auth login

This opens the web dashboard where you can sign up or log in.

2

Activate Your License

Copy your license key from the dashboard and activate it:

gqlgrab auth activate <your-license-key>
3

Check License Status

View your current license status and usage:

gqlgrab auth status

Offline Mode

Your license is cached locally with a 7-day grace period. Continue using Pro features offline for up to 7 days before re-validation is required.

Quick Start

1

Start the proxy server

gqlgrab capture --port 8080

This starts a local proxy server on port 8080 that captures all GraphQL requests.

2

Configure your application

Point your application or browser to use the proxy:

export HTTP_PROXY=http://localhost:8080
3

Make requests

Use your application normally. GraphQL Grab automatically detects and captures GraphQL requests.

4

Export the session

gqlgrab export session.json --format postman

Export captured requests to Postman, Insomnia, cURL, or HAR format.

HAR File Import

Already have network traffic captured? GraphQL Grab can analyze HAR files exported from browser DevTools or other network capture tools.

Export HAR from Chrome DevTools

  1. Open Chrome DevTools (F12 or Cmd+Opt+I)
  2. Go to the Network tab
  3. Perform your GraphQL operations
  4. Right-click in the Network panel and select "Save all as HAR with content"

Analyze the HAR File

gqlgrab analyze network.har

View statistics and summary of all GraphQL operations.

Search for Specific Operations

gqlgrab search network.har 'UserQuery'

Find specific queries or mutations by name.

Export to Other Formats

# Export to cURL commands
gqlgrab export network.har --format curl

# Export to Postman collection (Pro)
gqlgrab export network.har --format postman --output collection.json

# Export to Insomnia (Pro)
gqlgrab export network.har --format insomnia --output workspace.json

Commands Reference

capture

Start a proxy server and capture GraphQL requests

Usage

gqlgrab capture [options]

Options

--port, -pPort to run the proxy on (default: 8080)
--output, -oOutput file for session data (default: session.json)
--filterFilter requests by URL pattern

Example

gqlgrab capture --port 3000 --output my-session.json
analyze

Analyze a captured session or HAR file

Usage

gqlgrab analyze <file>

Options

--statsShow detailed statistics
--queriesList all unique queries
--mutationsList all unique mutations

Example

gqlgrab analyze session.json --stats
export

Export session to various formats

Usage

gqlgrab export <file> [options]

Options

--format, -fExport format: curl (free), postman, insomnia, har (Pro)
--output, -oOutput file path
--filterFilter operations by name pattern

Example

gqlgrab export session.json --format postman --output collection.json
search

Search for operations in a session

Usage

gqlgrab search <file> <query>

Options

--regex, -rUse regex pattern for search
--field, -fSearch in specific field: name, query, variables

Example

gqlgrab search session.json 'user' --regex
list

List all operations in a session

Usage

gqlgrab list <file> [options]

Options

--type, -tFilter by type: query, mutation, subscription
--verbose, -vShow detailed information

Example

gqlgrab list session.json --type query
auth

Manage license and authentication

Usage

gqlgrab auth <command>

Options

loginOpen browser to get license key
activate <key>Activate a license key
statusShow current license status
logoutDeactivate license and log out

Example

gqlgrab auth activate gql_xxxx...

Proxy Setup

Browser Configuration

Configure your browser to use the GraphQL Grab proxy:

CChrome / Edge

  1. Open Settings → System → Open proxy settings
  2. Set HTTP proxy to localhost:8080
  3. Apply settings

FFirefox

  1. Open Settings → Network Settings
  2. Select Manual proxy configuration
  3. Set HTTP Proxy to localhost, Port to 8080
  4. Click OK

System-Wide Proxy (macOS/Linux)

export HTTP_PROXY=http://localhost:8080
export HTTPS_PROXY=http://localhost:8080

System-Wide Proxy (Windows)

set HTTP_PROXY=http://localhost:8080
set HTTPS_PROXY=http://localhost:8080

Free vs Pro

Free Tier

  • Up to 100 requests per capture
  • 1 saved session
  • cURL export format
  • HAR file analysis
  • Search and filter operations

Pro

$12/month
  • Unlimited requests per capture
  • Unlimited saved sessions
  • All export formats (Postman, Insomnia, HAR, cURL)
  • 7-day offline grace period
  • Priority support
Upgrade to Pro

FAQ

Need Help?

Can't find what you're looking for? We're here to help.