Getting Started

Install the CLI

bun add -g @questpie/probe

Or with npm/pnpm:

npm install -g @questpie/probe
pnpm add -g @questpie/probe

Install the AI Skill

Give your AI coding agent the knowledge to use Probe:

bunx skills add questpie/probe

This installs the qprobe skill into your agent (Claude Code, Cursor, Windsurf). The agent will automatically use Probe when you ask it to test, debug, or verify your running app.

Initialize

Scaffold a qprobe.config.ts in your project:

qprobe init

This creates a config file with sensible defaults. Edit it to match your stack.

Quick Example

1. Start a dev server

qprobe start server "bun dev" --ready "ready on" --port 3000

The CLI spawns the process in the background, watches stdout for the ready pattern, and returns control once the server is up.

2. Check health

qprobe health http://localhost:3000/api/health

Polls the URL until it returns a 200 status (or times out).

3. Make an HTTP request

qprobe http GET /api/users --status 200 --jq ".length"

Sends a GET request to http://localhost:3000/api/users (baseUrl resolved from config or --port), asserts status 200, and prints the array length.

4. View logs

qprobe logs server --lines 20

Shows the last 20 lines from the server's log file.

5. Follow logs in real time

qprobe logs server --follow --level error

Streams new log entries, filtered to error level only.

6. Stop the server

qprobe stop server

Or stop everything:

qprobe stop --all

Using Compose

Define your full stack in qprobe.config.ts:

import { defineConfig } from '@questpie/probe'

export default defineConfig({
  services: {
    db: {
      cmd: 'docker compose up postgres',
      ready: 'ready to accept connections',
      health: 'http://localhost:5432',
    },
    server: {
      cmd: 'bun dev',
      ready: 'ready on http://localhost:3000',
      port: 3000,
      health: '/api/health',
      depends: ['db'],
    },
  },
})

Then start everything in dependency order:

qprobe compose up
qprobe compose status
qprobe compose down

Next Steps

• Command Reference — Full list of all commands and flags
• Configuration — All config file options
• Browser Drivers — Set up browser automation