Skip to content
useEventStack 0.3.0 is live.Read the quickstart

Tools

Terminal commands and interactive dashboard

Use the useeventstack CLI for event operations, webhook forwarding, WASM testing, and a full interactive TUI dashboard.

Installation

npm install -g @useeventstack/cli

Requires Node.js 18+. The binary is named useeventstack.

Authentication

Store and verify an API key:

useeventstack login useeventstack_your_key
useeventstack whoami
useeventstack logout

Credentials are saved to ~/.useeventstack/config.json. Project context is resolved from --project flag, USEEVENTSTACK_PROJECT_ID env var, or stored selection:

useeventstack project list
useeventstack project select <project-uuid>

Event commands

Emit an event

useeventstack event emit \
  -t deployment.completed \
  -p '{"service":"api","version":"2.1.0","environment":"production","status":"healthy"}' \
  -e sandbox \
  -k "deploy-api-2.1.0"

Query events

useeventstack event query -t deployment.completed -e production

Get and trace

useeventstack event get <event-id>
useeventstack event trace <event-id>

Tail live events

useeventstack tail -t "deployment.completed"

Replay

# Replay a single event
useeventstack replay single <event-id>

# Bulk replay with filters
useeventstack replay bulk \
  -t payment.failed \
  --since 2025-01-01T00:00:00Z \
  --until 2025-01-31T23:59:59Z \
  --limit 50

External side effects are suppressed by default. Pass --allow-side-effects to enable webhook delivery during replay.

Webhook forwarding

Start a local HTTP receiver for webhook testing:

useeventstack listen --port 3000

Prints incoming request methods, paths, and JSON bodies in real-time.

WASM action testing

Validate a compiled WASM binary header and structure locally:

useeventstack action test ./target/wasm32-unknown-unknown/release/my_action.wasm \
  --fixture ./fixtures/test_event.json

Schema tools

Generate mock payloads

useeventstack schema mock -t deployment.completed

Print contract JSON

useeventstack contract \
  -t billing.invoice_paid \
  -d "Fired when an invoice is fully paid" \
  -f customer_id -f amount -f currency

Promote environments

useeventstack promote --from sandbox --to production

Interactive TUI

Launch the full-screen terminal dashboard:

useeventstack tui

The TUI provides four views navigated with number keys:

KeyViewCapabilities
1DashboardSession info, runtime metrics, login/register/logout
2ConfigWorkflow and custom action CRUD, enable/disable, simulate
3PlaygroundSelect contracts, edit payloads, emit events
4Data ExplorerLive-polling events and contracts with detail inspection

The TUI uses $EDITOR (defaults to nano) for JSON editing.

Environment variables

VariableDescription
USEEVENTSTACK_API_KEYAPI key for authentication
USEEVENTSTACK_PROJECT_IDDefault project ID
USEEVENTSTACK_PUBLIC_API_URLAPI base URL (default: http://localhost:3001)
EDITOREditor for TUI JSON editing