Skip to content

Runsite terminal UI

Run runsite with no arguments, or runsite ui, and the CLI opens a full-screen dashboard in your terminal. It lists your projects, services and databases, tails logs, shows every deployment with its build log, and can deploy, restart, stop and roll back. It uses the same saved key and profiles as the rest of the CLI, and if there is no key it asks you to log in first.

The runsite terminal UI: the shop project on the left, its web services and databases with their statuses on the rightThe runsite terminal UI: the shop project on the left, its web services and databases with their statuses on the right
The dashboard. Projects on the left, the selected project's services and databases on the right.

The UI opens only in an interactive terminal. In a pipe, a CI job or with --output json, a bare runsite prints help instead, and every command works exactly as before.

KeyAction
↑ ↓, j kMove the selection
tab, ← →, h lSwitch between the Projects and Resources panes
enterOpen the selected item
1 2 3Open the selected service on Overview, Logs or Deploys
escGo back
/Filter the focused list
rRefresh now
PSwitch profile
?Show every key for the current screen
q, ctrl+cQuit

The bottom line lists the keys that work on the current screen and how long ago the data was refreshed.

The help window listing the dashboard keysThe help window listing the dashboard keys
Press ? on any screen for the full list of its keys.

The left pane lists your projects with the number of services and databases in each. An Unassigned row appears when some services have no project. The right pane shows the selected project: web services first, then PostgreSQL, then Redis, each with its status. A service row also shows its instance count; a database row shows the engine version.

Status icons:

IconMeaning
● greenRunning
○Stopped
◐Sleeping
spinnerDeploying, starting, stopping or restarting
✕ redFailed
⊘ redBlocked or being deleted

The UI remembers the project you last had selected and opens on it next time.

Opening a service gives three tabs, switched with 1 to 3 or tab.

Status, public URL, the branch or image it runs, instance count, the live deployment and any deployment in progress. CPU and memory show the current value next to a sparkline of the last hour.

Service overview in the runsite UI: running status, URL, branch, live deployment and CPU and memory usageService overview in the runsite UI: running status, URL, branch, live deployment and CPU and memory usage
The Overview tab of a running service.

A live tail of the service’s runtime logs, refreshed every two seconds.

Live nginx access logs in the runsite UI with line wrapping turned offLive nginx access logs in the runsite UI with line wrapping turned off
The Logs tab follows new lines as they arrive. Here wrapping is off, so long lines are cut at the edge.
KeyAction
j k, pgup pgdnScroll
g / GJump to the top / to the bottom and follow
fTurn following on or off
wTurn line wrapping on or off
← →Scroll sideways while wrapping is off
/, n NSearch, next match, previous match
cClear the view

Scrolling up stops following; G or f turns it back on. With several instances, the tab shows logs from the newest one.

The last ten deployments with status, commit, branch and age. The live one is marked live.

The Deploys tab listing two deployments of the storefront service, the newest one liveThe Deploys tab listing two deployments of the storefront service, the newest one live
Deployments of a service, newest first.

enter opens a deployment with its commit message, error message and full build log. Scroll the log with j k, pgup pgdn and g G.

A deployment opened in the runsite UI, showing the start of its build logA deployment opened in the runsite UI, showing the start of its build log
A deployment and its build log.

Keys that change something on the server are always uppercase, and each one asks you to confirm first. Only y confirms; n, esc and enter cancel.

KeyWhereAction
DDashboard, service screenBuild the latest commit and release it
RDashboard, service screenRestart the service without rebuilding
SDashboard, service or database screenStart or stop
BDeploys tab, deployment screenRoll back to the selected deployment
A confirm window over the dashboard asking to restart the storefront serviceA confirm window over the dashboard asking to restart the storefront service
Every action waits for y.

A key that cannot be used right now is greyed out in the bottom line, and pressing it tells you why. Typical reasons:

  • The key has the read scope. Actions need a write key.
  • A deployment is already in progress, so D, R and B wait until it finishes.
  • B works only on an earlier deployment that finished successfully, not on the live one.
  • The service is blocked or being deleted.

Deploys are limited to 5 per minute per key; other actions to 30 per minute.

Opening a PostgreSQL or Redis database shows its engine, plan, status, version and the internal and external hostnames. PostgreSQL databases also show CPU and memory. S starts or stops the database. Passwords are never shown; connect a database to a service with runsite db connect.

A PostgreSQL database in the runsite UI with its plan, version, hostnames and resource usageA PostgreSQL database in the runsite UI with its plan, version, hostnames and resource usage
A PostgreSQL database.

P lists the profiles in your config and switches to another one for this session. The profile saved as current does not change. A profile without a key opens the login screen, where you sign in with email and password or paste an API key.

When RUNSITE_API_TOKEN is set, the header shows env: RUNSITE_API_TOKEN instead of a profile name, and P is off because the variable overrides every profile.

  • The UI needs at least 60×15 characters. Below 100 columns the dashboard shows one pane at a time; below 20 rows the header shrinks to one line.
  • Colors are truecolor when COLORTERM is truecolor or 24bit, and 256 colors otherwise. NO_COLOR=1 turns them off.
  • RUNSITE_ASCII=1 replaces the logo, borders and icons with plain ASCII, which helps on the Linux console and in old Windows terminals.
  • Runsite CLI — install, log in and every command
  • API keys — scopes decide which actions the UI allows
IP geolocation by DB-IP