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.

Pre-1.0

Any pre-1.0 bump may ship breaking changes and reset run history. Check the CHANGELOG before upgrading. Semver guarantees land with 1.0.

Start here

Two ways in, depending on what you’ve already got running.

Quick startNothing to migrate? Install RunWisp, scaffold a runwisp.toml, and watch your first task stream live.

Coming from cron, supervisord, or docker-composeAlready have jobs running? Pick your source — RunWisp reads your existing config instead of making you rewrite it.

Learn your way around

Getting StartedInstall, first run, and guided tours of the embedded Web UI and the terminal UI.

How it worksWhy tasks and services differ, and how scheduling, concurrency, retries, and log retention actually behave.

Configuration ReferenceEvery key in runwisp.toml, table by table, with its default and what it does.

NotificationsDeclare a channel, route events to it, and set per-task alerts. Slack, Discord, Telegram, email, webhooks.

Get things done

GuidesWorked examples to crib from — nightly backups, health checks, deploy hooks, API triggers, Docker patterns.

Running in ProductionTroubleshooting, auth, surviving reboots, applying config edits, the daemon's own logs, and Prometheus metrics.

ReferenceThe lookup surfaces: every CLI command and flag, the REST API, and a dense guide for driving RunWisp with an AI agent.

API referenceREST endpoints and SSE log streams — generated from the OpenAPI schema.

Looking for something specific?

• A TOML field you saw in an example — search this site or jump straight to Configuration overview.
• A CLI command or flag — CLI reference lists every one, grouped by what you’re trying to do.
• Something’s broken — Troubleshooting is organised by symptom, not by subsystem.
• 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

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.