Skip to content

Installation

RunWisp is one Go binary. You list shell commands in runwisp.toml, and RunWisp runs them on a schedule or keeps them running, and records the output of every run. It runs on Linux, macOS, and WSL, on x86_64 or arm64.

Detects your OS and CPU, downloads the matching release, checks its SHA-256, and puts runwisp on your PATH.

Terminal window
curl -fsSL https://get.runwisp.com | sh

To update later, run runwisp upgrade. It uses the same method you installed with.

Run runwisp in the directory where your config should live:

Terminal window
runwisp

If there is no runwisp.toml there, it asks before creating one:

No runwisp.toml at /home/user/myproject.
Create a starter with one example task? [Y/n]

Press Enter. RunWisp writes the file, starts the daemon in the background, and opens the TUI. Answer no and nothing is written. If the machine has cron jobs, the same prompt offers to read them instead; see From cron.

The starter file has one task and two commented examples:

runwisp.toml
# runwisp.toml
# Docs: https://docs.runwisp.com/configuration/overview/
[tasks.hello]
description = "Example task. Trigger it from the TUI (press r) or the Web UI."
run = "echo hello from runwisp"
# Schedule a task with cron:
# [tasks.heartbeat]
# cron = "* * * * *"
# run = "date"
# Long-running service (auto-restart, supports multiple instances):
# [services.worker]
# instances = 1
# run = "node ./worker.js"

On a server with no terminal (Docker, systemd), use runwisp daemon instead: it never prompts, and exits with an error if the config is missing. To start RunWisp on boot, see Autostart.

All three ways use the same daemon and show up in the same run history.

Press ← to focus the sidebar, move to hello, and press r. The run opens and its output streams in live.

TUI run detail view: header with task name, run ID, timestamp, duration, and status badge; line-numbered log output below.

Press Esc to go back to the sidebar. The TUI page lists the other keys.

In the TUI, go to Home in the sidebar, select Open Web UI, and press Enter. Your browser opens the dashboard, already logged in.

TUI Home page: sidebar with task groups, right pane showing Open Web UI row, Web UI URL, masked password, and a recent-activity table.

The Home page also shows the Web UI address (http://localhost:9477 by default) and the generated password. Select the password and press Enter to copy it, for logging in from another browser. To set your own password or turn login off, see Authentication.

Web UI dashboard: sidebar with tasks and services, daemon header with sparklines, recent activity feed below.Web UI dashboard: sidebar with tasks and services, daemon header with sparklines, recent activity feed below.