Skip to content

Installation

Prerequisites

  • Node.js >= 18 — peekr uses modern Node.js APIs and includes a Node 18-compatible interception fallback. Check your version:
node --version
# v18.0.0 or higher

No other tools or dependencies are required.

Install once, use anywhere:

npm install -g @marcosreuquen/peekr

Verify it works:

peekr --help

You should see:

peekr --target <host> [options]    Standalone proxy mode
peekr run [options] -- <command>   Spawn app with auto-interception
peekr ui [options] [-- <command>]  Live web dashboard

Run with npx (no install)

If you prefer not to install globally, use npx to run peekr directly:

npx @marcosreuquen/peekr --help
npx @marcosreuquen/peekr run -- node server.mjs
npx @marcosreuquen/peekr ui --app-port 3000 -- npm run dev

This downloads peekr on first use and caches it locally.

Project-level install

You can also add peekr as a dev dependency:

npm install -D @marcosreuquen/peekr

Then use it in package.json scripts:

{
  "scripts": {
    "dev:debug": "peekr run -- npm run start:dev",
    "dev:ui": "peekr ui --app-port 3000 -- npm run start:dev"
  }
}

Next steps

Head to the Quick Start to try each mode hands-on.