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 start Install RunWisp, scaffold a runwisp.toml, and watch your first task stream live.
The Web UI tour Login, runs, tasks, notifications — what the embedded dashboard does.

Reference

Section titled “Reference”
Concepts How scheduling, concurrency, retries, logs, and notifications fit together.
Configuration Every key in runwisp.toml — tasks, services, storage, defaults.
Notifications The notifications model, outbound providers, routing rules, and per-task notifications.
API reference REST endpoints and SSE log streams — generated from the OpenAPI schema.

In production

Section titled “In production”
Auth The password, CHAP login, sessions, the local Unix socket, and how to turn auth off for local dev.
Autostart One command to survive reboots — systemd, launchd, and the WSL recipe.
Logging & metrics The daemon's own logs, plus the Prometheus-compatible /metrics endpoint.
Recipes Worked 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 Apache-2.0 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.