Skip to content
RunWisp

RunWisp documentation

RunWisp is one small Go binary that does the job of crond plus a supervisor — and never lets a failure slip past silently. You describe your tasks and services in a single runwisp.toml, and every run gets an exit code, duration, and captured output you can browse in the embedded Web UI, watch live in the TUI, or pull over the REST API. These docs walk you through the whole thing — getting the binary onto a box, writing that config file, and keeping the daemon happy in production.

Start here

Section titled “Start here”
Quick startInstall RunWisp, scaffold a runwisp.toml, and watch your first task stream live.
The Web UI tourLogin, runs, tasks, notifications — what the embedded dashboard does.
Replacing cronAlready on crond? One command hands every job over — nothing rewritten, nothing fires twice.
DockerRun RunWisp in a container — the official image, env vars, volumes, and why your tasks need their tools baked in.

Reference

Section titled “Reference”
ConceptsHow scheduling, concurrency, retries, logs, and notifications fit together.
ConfigurationEvery key in runwisp.toml — tasks, services, storage, defaults.
NotificationsThe notifications model, outbound providers, routing rules, and per-task notifications.
API referenceREST endpoints and SSE log streams — generated from the OpenAPI schema.

In production

Section titled “In production”
AuthThe password, CHAP login, sessions, the local Unix socket, and how to turn auth off for local dev.
AutostartOne command to survive reboots — systemd, launchd, and the WSL recipe.
Logging & metricsThe daemon's own logs, plus the Prometheus-compatible /metrics endpoint.
RecipesWorked examples — nightly backups, health checks, Slack alerts, deploy hooks.

Looking for something specific?

Section titled “Looking for something specific?”
  • A TOML field you saw in an example — search this site or jump straight to Configuration overview.
  • A REST endpoint — API reference is generated from the OpenAPI schema; the same schema ships as /openapi.json from a running daemon.
  • A version’s breaking changes — the CHANGELOG lists them per release.

Source and contributing

Section titled “Source and contributing”

RunWisp is open source under GPL-3.0-or-later and developed at github.com/runwisp/runwisp. Every docs page has an “Edit this page” link in its footer that points at the source MDX file — typo fixes and clarifications welcome as PRs against main.