Getting Started on spectralab

Installation

Mon, 01 Jan 0001 00:00:00 +0000

Installation#

Download a Binary#

Pre-built binaries are available for the following platforms:

Platform	Architecture
macOS	Apple Silicon (arm64)
macOS	Intel (amd64)
Linux	arm64
Linux	amd64

Download the binary for your platform, extract it, make it executable, and move it somewhere on your PATH:

chmod +x simuhook-darwin-arm64
mv simuhook-darwin-arm64 /usr/local/bin/simuhook

Build from Source#

Requires Go 1.21+.

git clone https://github.com/abojaber/simuhook
cd simuhook
go build -o simuhook ./src

This produces the simuhook binary in the current directory.

Quick Start

Mon, 01 Jan 0001 00:00:00 +0000

Quick Start#

Five steps from zero to a working mocked endpoint.

1. Start the Server#

simuhook

The server starts on :8080, watches the stubs/ directory, and logs requests to logs/. On a terminal it opens the interactive TUI dashboard; on a non-TTY (like a pipe) it prints a startup banner and one line per request.

2. Verify It’s Running#

curl http://localhost:8080/health
# → {"status":"ok"}

The repository ships with example stubs, including a GET /health endpoint.

Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Configuration#

Simuhook is configured through CLI flags and environment variables. Flags take precedence over environment variables.

CLI Flags#

simuhook [flags]

 --addr :8080 listen address (env PORT)
 --stubs ../stubs stubs directory (env STUBS_DIR)
 --log-dir logs log directory (env LOG_DIR)
 --tui auto|on|off dashboard mode: auto = TUI on a TTY, line output otherwise
 --recent N recent-log ring buffer size (default 50; also the TUI feed depth)
 --max-log-body N cap stored request/response body size in bytes for logs and
 dashboard (default 0 = unlimited; env LOG_MAX_BODY). Never affects
 the actual HTTP response bytes.
 --help print usage and exit
 --version print version and exit

Environment Variables#

Variable	Default	Overrides
`PORT`	`:8080`	`--addr`
`STUBS_DIR`	`stubs/`	`--stubs`
`LOG_DIR`	`logs/`	`--log-dir`
`LOG_MAX_BODY`	`0` (unlimited)	`--max-log-body`

Common Scenarios#

Run on a different port: