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.
Method | Best for |
---|---|
npx | Quick one-off runs without installing |
Homebrew | macOS users who want easy updates |
npm | Cross-platform installation using npm for Windows, macOS, Linux |
Binary | Cross-platform installation using the binaries for Windows, macOS, Linux |
Quick installation (npx)
Section titled “Quick installation (npx)”Use npx
to try Inspectr without installing anything globally:
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
Full installation
Section titled “Full installation”Install Inspectr permanently using Homebrew, npm, or a standalone binary.
Homebrew (macOS)
Section titled “Homebrew (macOS)”Install Inspectr on macOS using package Manager Homebrew:
brew tap inspectr-hq/inspectrbrew install inspectr
Run Inspectr:
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.
npm install -g @inspectr/inspectr
Run Inspectr like this:
inspectr --backend=http://localhost:3000
- Installs Inspectr globally via the Node package manager.
- Update later using
npm update -g @inspectr/inspectr
Binary
Section titled “Binary”Download the binary for your platform from GitHub Releases:
./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
Next step
Section titled “Next step”You’re ready to run Inspectr and start debugging API traffic in seconds.