RunWisp documentation

These docs cover every part of running the RunWisp daemon — from installing the binary on a laptop to deploying it under systemd with a reverse proxy. RunWisp is a single Go binary that replaces crond plus a small supervisor: tasks and services in one runwisp.toml, run history and live logs in an embedded Web UI, and a REST API for automation.

This site is reference material. For the project pitch, blog, and release announcements, head to runwisp.com.

Start here

Install One-liner installer, bunx, or a tarball — Linux / macOS / WSL.

Your first task Write a runwisp.toml, start the daemon, watch a run stream live.

Reference

Concepts How scheduling, concurrency, retries, logs, and notifications fit together.

Configuration Every key in runwisp.toml — tasks, services, storage, defaults.

Notifications The model, [[notifier]] providers (Slack, Telegram, …), routing, and per-task sugar.

CLI reference Every subcommand and flag — daemon, exec, run-task, list, status, init.

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

In production

Deploy VPS, Docker, and a hardened systemd unit — the canonical bring-up flows.

Operations Auth, data directory, upgrades between versions, and troubleshooting.

Recipes Worked examples — nightly backups, health checks, Slack alerts, deploy hooks.

The Web UI tour Login, runs, tasks, notifications — what the embedded dashboard does.

Looking for something specific?

• A TOML field you saw in an example — search this site or jump straight to Configuration overview.
• A subcommand or flag — CLI reference lists every one.
• A REST endpoint — API reference is generated from the OpenAPI schema; the same schema ships as /openapi.json from a running daemon.
• An error message — Troubleshooting is organised by symptom and lists the exact strings the daemon emits.
• A version’s breaking changes — Upgrading maps each bump (0.1 → 0.2 → 0.3 → 0.4).

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.