CLI Reference

The errpulse CLI starts the ErrPulse server and manages its lifecycle.

Installation

The CLI is available as the errpulse npm package. You can run it directly with npx:

npx errpulse

Or install it globally:

npm install -g errpulse

Commands

errpulse / errpulse start

Start the ErrPulse server.

npx errpulse
npx errpulse start
npx errpulse start --port 4000

Options:

Flag	Description	Default
--port <number>	Port to run the server on	3800

This starts:

• The REST API server
• The SQLite database (created at ~/.errpulse/errpulse.db if it doesn't exist)
• The WebSocket server for real-time updates
• The dashboard (served at the root URL)

errpulse status

Check if the ErrPulse server is running.

npx errpulse status

Output when running:

ErrPulse is running
Uptime: 1h 23m 45s

Output when not running:

ErrPulse is not running

Uses a 3-second timeout to check the GET /api/health endpoint.

errpulse clear

Clear all stored data (errors, events, requests, projects).

npx errpulse clear

This sends a POST /api/clear request to the running server. The server must be running for this command to work.

errpulse help

Show usage information.

npx errpulse help
npx errpulse -h
npx errpulse --help

Environment Variables

Variable	Description	Default
ERRPULSE_PORT	Port to run the server on	3800
ERRPULSE_HOST	Host to bind the server to	0.0.0.0

Environment variables are overridden by CLI flags. For example:

ERRPULSE_PORT=4000 npx errpulse          # Uses port 4000
npx errpulse start --port 5000            # Uses port 5000
ERRPULSE_PORT=4000 npx errpulse --port 5000  # Uses port 5000 (flag wins)

Exit Codes

Code	Meaning
0	Success
1	Error (server not running, connection failed, etc.)