RaisDBRaisDB
TUI

TUI

The `raisdb tui` full-screen terminal browser — schema tree, data grid, SQL editor overlay, and status bar.

The TUI is a full-screen terminal interface for browsing databases without leaving your terminal. Built with ratatui.

Start

raisdb tui                       # pick connection interactively, read-only (default)
raisdb tui main                  # open the "main" connection
raisdb tui main --readwrite      # allow writes
raisdb tui main --database app   # start in a specific database

The TUI is read-only by default. --readwrite starts it in read-write mode.

For batch jobs and pipelines, use the CLI instead.

Panels

Two panels plus a status bar:

PanelLocationPurpose
Schema treeLeft (30%)Tables / views, expandable
Data gridRight (70%)Current table's rows
Status barBottom (1 line)Mode badge, current table, rows / ms / server version

Other surfaces — SQL editor, row detail, command bar, search bar — render as overlays on top of the main panels, not as their own region.

Where it fits

  • SSH'd into a server with no GUI
  • Quick data check alongside your editor (tmux pane)
  • Pairing with tmux / zellij

See also

Scripting

Pipe RaiseDB into your existing toolchain — JSON output, files, exit codes, env vars.

TUI Layout

Two panels plus a status bar, with overlays for the editor and detail views.

On this page

StartPanelsWhere it fitsSee also