Skip to content

Installation

Getting started with Inspectr is simple. The table below summarizes the different installation methods. Pick the one that best fits your workflow and follow the steps after the table.

MethodBest for
npxQuick one-off runs without installing
HomebrewmacOS users who want easy updates
npmCross-platform installation using npm for Windows, macOS, Linux
BinaryCross-platform installation using the binaries for Windows, macOS, Linux

Use npx to try Inspectr without installing anything globally:

Terminal window
npx @inspectr/inspectr --backend=http://localhost:3000
  • Downloads the latest version on each run
  • Great for quick experiments or CI jobs
  • The UI becomes available at http://localhost:4004

Install Inspectr permanently using Homebrew, npm, or a standalone binary.

Install Inspectr on macOS using package Manager Homebrew:

Terminal window
brew tap inspectr-hq/inspectr
brew install inspectr

Run Inspectr:

Terminal window
inspectr --backend=http://localhost:3000
  • Works on macOS
  • brew upgrade inspectr keeps it up to date

Use npm to install Inspectr on Windows, macOS and Linux.

Terminal window
npm install -g @inspectr/inspectr

Run Inspectr like this:

Terminal window
inspectr --backend=http://localhost:3000
  • Installs Inspectr globally via the Node package manager.
  • Update later using npm update -g @inspectr/inspectr

Download the binary for your platform from GitHub Releases:

Terminal window
./inspectr --backend=http://localhost:3000

💡 Tip: Make sure the binary is executable (chmod +x ./inspectr) if needed.

  • Binaries are available for macOS, Linux, and Windows.
  • Just download the appropriate binary, extract it, and run it

You’re ready to run Inspectr and start debugging API traffic in seconds.

Quick Start →