Skip to content
RunWisp

TUI

The TUI runs in your terminal. It connects to a daemon on the same machine over its socket, or to a remote daemon over HTTP.

Terminal window
runwisp                                       # start the local daemon if needed, then open the TUI
runwisp tui                                   # open the TUI for a daemon that is already running
runwisp tui --url https://runwisp.example.com # connect to a remote daemon

Locally, no password is needed. With --url, the TUI logs in with the Web UI password: it reads RUNWISP_PASSWORD or asks once, then remembers the session. See Authentication.

Press ? at any time for the full list of keys. The bar at the bottom shows the keys for whatever is focused.

Layout

Section titled “Layout”

The sidebar on the left starts with Home, followed by your tasks and services (grouped by group), then Info and Debug at the bottom. ▸ marks what the right pane shows. Moving the cursor does nothing until you press Enter.

Home

Section titled “Home”

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

  • Open Web UI: opens your browser, already logged in. Without a browser, the TUI copies the link to your clipboard, or shows it for you to copy. Over plain http:// to a remote host, it asks first, because the login link would travel unencrypted.
  • Web UI: the address. Enter copies it.
  • Password: shown only when the daemon generated the password. Enter copies it.
  • Recent activity: the latest runs across all tasks.

Press n to open the notifications panel. If some tasks come from crontabs that cron still runs, the header shows how many are held. It also counts paused schedules.

Task detail

Section titled “Task detail”

Select a task or service in the sidebar to see its schedule, a Run Now (or Restart) button, and its run history. Run Now asks for confirmation, or opens a form if the task has parameters.

TUI task detail for healthcheck-api: header with task name, cron schedule, next-fire countdown, and Run Now button; run history table below showing status, start time, duration, and trigger columns.

  • f filters the runs by status. A banner shows while a filter is active.
  • i shows the task’s full definition and recent health.
  • p pauses or resumes the task’s schedule. u undoes it while its notice is showing.
  • space selects runs, a selects all that match the filter. Then d deletes, c cancels, and e re-runs them. u undoes a delete while its notice is showing.

Following a run

Section titled “Following a run”

Press Enter on a run to open it. The log streams live, with line numbers, under a header with the run ID, start time, duration, and status.

TUI run detail for reindex-search: header with Back button, run ID, timestamp, duration, and status badge; line-numbered log output below.

  • The log follows new lines. Scrolling up pauses that; G jumps back to the end and follows again.
  • f shows only the log, full screen, for copying.
  • d downloads the log. Without a browser, you get the download link instead.
  • r runs it again, s stops it. Both ask first.
  • i shows the run’s exit code, trigger, timing, and retries. For a retry, Enter jumps to the attempt it retried.

TUI fullscreen log view: no sidebar, no header, pure log lines filling the terminal.

Reading a failure

Section titled “Reading a failure”

The run header tells you what went wrong before you read the log:

  • Status: why the run ended: failed, timeout, crashed, stopped, skipped, log_overflow, and others.
  • Exit code: what the command returned. -1 means the run was skipped and never started (on_overlap = "skip"). -2 means the daemon died during the run (crashed). A timeout usually shows 143 (SIGTERM) or 137 (SIGKILL).

In the sidebar, a task whose last run failed has a coloured marker. With retries, every attempt is its own run with its own log.

Info and Debug

Section titled “Info and Debug”

Info shows CPU and memory graphs, run counts, version, and uptime.

TUI Info page: CPU and memory sparklines, activity summary, version and platform details, configuration checkmarks, and task list.

Debug shows the daemon’s own log. Reconnect messages appear here when the connection drops. The TUI reconnects by itself.

Keyboard shortcuts

Section titled “Keyboard shortcuts”
Key Action
? Show all keys
q / Ctrl+C Quit
↑↓ / kj Move
←→ / hl Switch between sidebar and main pane
Enter Open, activate, or copy a field
Esc / ⌫ Back
/ Filter tasks (sidebar) or search the task’s logs
r Run now (task), restart (service), or retry (run)
s Stop a run or service
p Pause or resume a task’s schedule
R Reload runwisp.toml (Reload)
n Notifications panel (on Home)
i Task or run details
f Filter runs, or full-screen log in a run
d / D In a run: download the log / delete the run
g / G Jump to the top / end of the log

Quitting

Section titled “Quitting”

Press q. The TUI asks whether to keep the daemon running in the background or shut it down. Esc cancels.

TUI quit confirmation dialog: modal asking “Keep the daemon running in the background?” with Keep Running and Shut Down buttons.

  • Shut Down stops the local daemon, also under runwisp tui. Connected with --url, it only closes the TUI.
  • A daemon run by systemd or launchd has no Shut Down option. Use runwisp stop.