|
| 1 | +--- |
| 2 | +title: LEET terminal UI |
| 3 | +description: Explore and compare local W&B runs from the terminal with the LEET (Lightweight Experiment Exploration Tool) TUI. |
| 4 | +--- |
| 5 | + |
| 6 | +W&B LEET (Lightweight Experiment Exploration Tool) is a keyboard-driven terminal UI for exploring runs logged on the machine where you work. Use LEET to compare metrics, inspect system utilization, browse logged images, and tail console output without opening a browser. LEET reads local `.wandb` transaction logs, so you can inspect runs before they sync to the cloud. |
| 7 | + |
| 8 | +<Frame> |
| 9 | + <img src="/images/leet/leet-workspace-all-panes.png" alt="W&B LEET workspace view with runs, metrics, system metrics, media, console logs, and run overview panes." /> |
| 10 | +</Frame> |
| 11 | + |
| 12 | +## When to use LEET |
| 13 | + |
| 14 | +LEET is built for engineers who spend most of their time in a terminal, especially on remote machines, clusters, or SSH sessions where a graphical browser is slow or unavailable. |
| 15 | + |
| 16 | +| Surface | Best for | |
| 17 | +| --- | --- | |
| 18 | +| **LEET** | Local run folders on the machine that logged them; fast keyboard navigation; live monitoring while a job is still writing logs; SSH and `tmux` workflows. | |
| 19 | +| **[W&B App](/models/runs/view-logged-runs)** | Full project workspaces, team collaboration, reports, sweeps, artifacts, and rich panel types across synced cloud runs. | |
| 20 | +| **[W&B mobile app](/platform/hosting/monitoring-usage/mobile-app)** | Lightweight monitoring and alerts for synced cloud projects on a phone (Multi-tenant Cloud only). | |
| 21 | + |
| 22 | +LEET and the W&B App show the same underlying run data when that data exists locally and has been synced. LEET does not replace a project workspace in the browser. It is a different interface over local run files and live updates from an active training process. |
| 23 | + |
| 24 | +## Prerequisites |
| 25 | + |
| 26 | +Install or upgrade the W&B CLI to the latest release using `pip` or `uv`: |
| 27 | + |
| 28 | +<Tabs> |
| 29 | +<Tab title="pip"> |
| 30 | +```bash |
| 31 | +pip install --upgrade wandb |
| 32 | +``` |
| 33 | +</Tab> |
| 34 | +<Tab title="uv"> |
| 35 | +```bash |
| 36 | +uv pip install --upgrade wandb |
| 37 | +``` |
| 38 | +</Tab> |
| 39 | +</Tabs> |
| 40 | + |
| 41 | +This guide tracks the latest CLI behavior. For version-by-version changes, see the [changelog](#changelog) on this page. |
| 42 | + |
| 43 | +<Note> |
| 44 | +In SDK v0.27.x and earlier, launch the LEET TUI with `wandb beta leet` instead of `wandb leet`. |
| 45 | +</Note> |
| 46 | + |
| 47 | +## Launch LEET |
| 48 | + |
| 49 | +From the directory that contains your `wandb/` folder, open the default workspace and auto-select the latest local run: |
| 50 | + |
| 51 | +```bash |
| 52 | +wandb leet |
| 53 | +``` |
| 54 | + |
| 55 | +You can pass an optional `PATH` that points to a workspace directory, a specific run directory, or a `.wandb` file: |
| 56 | + |
| 57 | +```bash |
| 58 | +wandb leet ./wandb |
| 59 | +wandb leet ./wandb/offline-run-20260403_145048-6ao9fhns |
| 60 | +wandb leet ./wandb/offline-run-20260403_145048-6ao9fhns/run-6ao9fhns.wandb |
| 61 | +``` |
| 62 | + |
| 63 | + |
| 64 | +Open the standalone system monitor (SYMON) to view host metrics without a run context: |
| 65 | + |
| 66 | +```bash |
| 67 | +wandb leet symon --interval 2s |
| 68 | +``` |
| 69 | + |
| 70 | +For command syntax and subcommands, see [`wandb leet`](/models/ref/cli/wandb-leet) in the CLI reference. |
| 71 | + |
| 72 | +## Views and pane layout |
| 73 | + |
| 74 | +LEET has three main views: **workspace**, **single-run**, and **SYMON**. |
| 75 | + |
| 76 | +### Workspace view |
| 77 | + |
| 78 | +Workspace view is the default. It is designed to compare multiple runs from the same local `wandb/` directory. |
| 79 | + |
| 80 | +Typical panes include: |
| 81 | + |
| 82 | +- **Runs sidebar** — browse and filter local run folders. |
| 83 | +- **Metrics grid** — overlay selected runs on the same scalar charts. |
| 84 | +- **System metrics** — charts for the highlighted run. |
| 85 | +- **Media** — `wandb.Image` thumbnails rendered in the terminal. |
| 86 | +- **Console logs** — assembled stdout and stderr for the highlighted run. |
| 87 | +- **Run overview** — state, IDs, tags, notes, config, and summary values. |
| 88 | + |
| 89 | +Use `space` to select or deselect a run for overlaid metrics. Selected runs have a filled icon. Use `p` to pin a run so its series stays on top in metric charts. Press `enter` on the highlighted run to open **single-run view**. Live runs keep updating in the workspace, so you can use LEET for both post-run analysis and monitoring an active job. |
| 90 | + |
| 91 | +### Single-run view |
| 92 | + |
| 93 | +Single-run view focuses on one run with a metrics grid in the center, run overview on the left, and system metrics on the right. Media and console log panes open below the metrics grid when toggled on. |
| 94 | + |
| 95 | +<Frame> |
| 96 | + <img src="/images/leet/leet-single-run-view.png" alt="W&B LEET single-run view with run overview, metric charts, and system metrics panes." /> |
| 97 | +</Frame> |
| 98 | + |
| 99 | +Press `esc` to return to workspace view. |
| 100 | + |
| 101 | +### SYMON |
| 102 | + |
| 103 | +SYMON watches local CPU, memory, disk, network, and accelerator metrics. It uses the same chart engine as run-backed system metrics panes but is not tied to a W&B run file. |
| 104 | + |
| 105 | +<Frame> |
| 106 | + <img src="/images/leet/leet-system-metrics-heatmap.png" alt="W&B LEET system metrics view with GPU charts and bucketed heatmap mode." /> |
| 107 | +</Frame> |
| 108 | + |
| 109 | +## Key features |
| 110 | + |
| 111 | +### Multi-run comparison |
| 112 | + |
| 113 | +Select multiple runs in workspace view to compare scalar metrics on shared charts. Each run gets a stable color, and LEET reduces base color collisions so overlaid series stay distinguishable. Pinning is useful when many runs are selected and you want one series to render above the rest. |
| 114 | + |
| 115 | +Press `f` to filter the runs list by name, project, tags, notes, config values, and other metadata. Bare terms search across run key, display name, run ID, project, tags, and notes. The filter also supports fielded queries: |
| 116 | + |
| 117 | +| Query | Matches | |
| 118 | +| --- | --- | |
| 119 | +| `project:vision` | Project name. | |
| 120 | +| `name:baseline` | Display name. Aliases: `run_name`, `display`, `display_name`. | |
| 121 | +| `id:abc123` | Run ID. Alias: `run_id`. | |
| 122 | +| `key:offline-run` | Run directory key. Aliases: `run_key`, `path`. | |
| 123 | +| `tag:prod` | Tags. Alias: `tags`. | |
| 124 | +| `note:debug` | Notes. Alias: `notes`. | |
| 125 | +| `config:adamw` or `cfg:adamw` | Any flattened config key or value. | |
| 126 | +| `cfg.lr>=1e-3` | A specific nested config path. `config.lr` also works. | |
| 127 | +| `has:notes` or `exists:cfg.dataset` | Existence check. | |
| 128 | + |
| 129 | +Supported operators are `:`, `=`, `!=`, `>`, `>=`, `<`, and `<=`. Numeric comparisons are useful for config values such as learning rate, batch size, or number of layers. |
| 130 | + |
| 131 | +Use whitespace or `AND` for conjunction, `OR` or `|` for alternatives, and `-`, `!`, or `NOT` for negation. Use quotes for phrases with spaces. |
| 132 | + |
| 133 | +```text |
| 134 | +transformer |
| 135 | +project:vision tag:baseline |
| 136 | +cfg.lr>=1e-3 cfg.optimizer=adamw |
| 137 | +has:notes -tag:debug |
| 138 | +project:vision tag:baseline cfg.lr>=1e-3 -note:debug | project:nlp |
| 139 | +``` |
| 140 | + |
| 141 | +While editing a filter, press `tab` to switch between regex and glob modes. Regex mode behaves like a case-insensitive substring search unless the query contains regex metacharacters. Glob mode supports `*` for any sequence and `?` for any single character. |
| 142 | + |
| 143 | +### Metrics and system metrics |
| 144 | + |
| 145 | +LEET renders scalar metrics as terminal line charts. Filter run metrics with `/` and system metrics with `\`. Press `y` on a focused chart to cycle modes such as log-scale Y or bucketed heatmap views for percentage-based system metrics. |
| 146 | + |
| 147 | +Use the mouse wheel to zoom the focused chart. On live system metric charts, LEET defaults to a rolling tail window (10 minutes by default). Right-click and drag on a chart to inspect the nearest point. Hold `alt` while dragging to inspect all visible charts at the same X position. |
| 148 | + |
| 149 | +### Media and console logs |
| 150 | + |
| 151 | +The media pane shows `wandb.Image` series as ANSI thumbnails. Toggle it with `3` in workspace or single-run view. |
| 152 | + |
| 153 | +<Frame> |
| 154 | + <img src="/images/leet/leet-media-workspace.png" alt="W&B LEET workspace view with the media pane showing several image series." /> |
| 155 | +</Frame> |
| 156 | + |
| 157 | +Toggle console logs with `4`. LEET rebuilds readable log lines from raw terminal output, including ANSI escape codes and carriage-return progress lines. |
| 158 | + |
| 159 | +For console log behavior in the W&B App, see [Console logs](/models/app/console-logs). |
| 160 | + |
| 161 | +### Configuration |
| 162 | + |
| 163 | +Persist layout, colors, default panes, and startup mode with the config editor: |
| 164 | + |
| 165 | +```bash |
| 166 | +wandb leet config |
| 167 | +``` |
| 168 | + |
| 169 | +LEET writes `wandb-leet.json` under `~/.config/wandb/` by default, or under `WANDB_CONFIG_DIR` when that variable is set. You can also resize grids from inside LEET with `c` and `r`. |
| 170 | + |
| 171 | +<Frame> |
| 172 | + <img src="/images/leet/leet-config-editor.png" alt="W&B LEET config editor showing grid settings, color schemes, visibility settings, and palette selection." /> |
| 173 | +</Frame> |
| 174 | + |
| 175 | +### Common config keys |
| 176 | + |
| 177 | +| Key | Default | Description | |
| 178 | +| --- | --- | --- | |
| 179 | +| `startup_mode` | `workspace_latest` | Initial view when launched without a run path. | |
| 180 | +| `metrics_grid.rows`, `metrics_grid.cols` | `4`, `3` | Single-run metrics grid size. | |
| 181 | +| `system_grid.rows`, `system_grid.cols` | `6`, `2` | Single-run system metrics sidebar grid size. | |
| 182 | +| `media_grid.rows`, `media_grid.cols` | `1`, `2` | Single-run media grid size. | |
| 183 | +| `workspace_metrics_grid.rows`, `workspace_metrics_grid.cols` | `3`, `3` | Workspace metrics grid size. | |
| 184 | +| `workspace_system_grid.rows`, `workspace_system_grid.cols` | `3`, `3` | Workspace system metrics grid size. | |
| 185 | +| `workspace_media_grid.rows`, `workspace_media_grid.cols` | `1`, `2` | Workspace media grid size. | |
| 186 | +| `symon_grid.rows`, `symon_grid.cols` | `3`, `3` | SYMON grid size. | |
| 187 | +| `color_scheme` | `wandb-vibe-10` | Palette for workspace run metrics and run list colors. | |
| 188 | +| `per_plot_color_scheme` | `sunset-glow` | Palette for single-run charts when `single_run_color_mode` is `per_plot`. | |
| 189 | +| `tag_color_scheme` | `wandb-vibe-10` | Palette for tag badges in the overview sidebar. | |
| 190 | +| `system_color_scheme` | `wandb-vibe-10` | Palette for system metric charts. | |
| 191 | +| `french_fries_color_scheme` | `viridis` | Palette for bucketed heatmap charts. | |
| 192 | +| `single_run_color_mode` | `per_series` | Color single-run charts per series or per plot. | |
| 193 | +| `system_color_mode` | `per_series` | Color system charts per series or per plot. | |
| 194 | +| `system_tail_window_minutes` | `10` | Default live tail window for system charts. | |
| 195 | +| `heartbeat_interval_seconds` | `15` | Polling heartbeat for live runs. | |
| 196 | +| `workspace_overview_visible` | `true` | Show the workspace run overview sidebar by default. | |
| 197 | +| `workspace_metrics_grid_visible` | `true` | Show the workspace metrics grid by default. | |
| 198 | +| `workspace_system_metrics_visible` | `false` | Show the workspace system metrics pane by default. | |
| 199 | +| `workspace_console_logs_visible` | `false` | Show the workspace console logs pane by default. | |
| 200 | +| `workspace_media_visible` | `false` | Show the workspace media pane by default. | |
| 201 | +| `left_sidebar_visible` | `true` | Show the single-run overview sidebar by default. | |
| 202 | +| `right_sidebar_visible` | `true` | Show the single-run system metrics sidebar by default. | |
| 203 | +| `metrics_grid_visible` | `true` | Show the single-run metrics grid by default. | |
| 204 | +| `console_logs_visible` | `false` | Show the single-run console logs pane by default. | |
| 205 | +| `media_visible` | `false` | Show the single-run media pane by default. | |
| 206 | + |
| 207 | +Several color schemes are available, like `wandb-vibe-10`, `wandb-vibe-20`, `sunset-glow`, `blush-tide`, `gilded-lagoon`, `bootstrap-vibe`, `dusk-shore`, `clear-signal`, `traffic-light`, `viridis`, `plasma`, `inferno`, `magma`, and `cividis`. |
| 208 | + |
| 209 | +- Palettes `dusk-shore` and `clear-signal` are colorblind-friendly. |
| 210 | +- Sequential palettes such as `viridis`, `plasma`, `inferno`, `magma`, `cividis`, and `traffic-light` work well for bucketed heatmaps. |
| 211 | + |
| 212 | +## Navigate with the keyboard |
| 213 | + |
| 214 | +LEET is designed for keyboard and mouse input. Press `h` or `?` inside LEET to open the in-app help overlay for the current view. |
| 215 | + |
| 216 | +Across workspace and single-run views: |
| 217 | + |
| 218 | +- `tab` and `shift+tab` cycle focus between visible panes. |
| 219 | +- `w`, `a`, `s`, `d` and the arrow keys move within the focused pane (except in the media pane, where arrows scrub the X-axis and WASD moves between tiles). |
| 220 | +- `home`, `end`, `pgup`, and `pgdown` jump within lists, chart pages, or media frames. |
| 221 | +- `1`, `2`, `3`, and `4` toggle the metrics grid, system metrics, media, and console logs panes. |
| 222 | +- `[` and `]` toggle sidebars (runs list, run overview, or system metrics depending on the view). |
| 223 | + |
| 224 | +For the full shortcut tables for workspace, single-run, SYMON, and mouse actions, see [Keyboard shortcuts](/models/app/keyboard-shortcuts) (LEET tab). |
| 225 | + |
| 226 | +## Limitations compared to the W&B App |
| 227 | + |
| 228 | +LEET complements the W&B App but does not replicate every workspace capability. |
| 229 | + |
| 230 | +| Capability | LEET | W&B App | |
| 231 | +| --- | --- | --- | |
| 232 | +| Data source | Local `wandb/` directories and `.wandb` files on the current machine | Synced cloud projects and teams | |
| 233 | +| Run comparison | Multiple local runs in one directory | Full workspace tables, grouping, and saved views | |
| 234 | +| Panel types | Scalar line charts, system metrics, `wandb.Image` media, console logs | Line, bar, scatter, parallel coordinates, media, code, query panels, custom charts, and more | |
| 235 | +| Collaboration | Single-user terminal session | Sharing, comments, reports, and team features | |
| 236 | +| Artifacts and files | Not available | Artifacts, Files, and Code tabs per run | |
| 237 | +| Sweeps and registry | Not available | Sweep dashboards, registry, and automations | |
| 238 | + |
| 239 | +If you need artifacts, sweep analysis, or panel types that LEET does not provide, open the run in the [W&B App](/models/runs/view-logged-runs) after syncing. |
| 240 | + |
| 241 | +## Changelog |
| 242 | + |
| 243 | +LEET was initially launched in beta in SDK v0.23.0, and graduated to GA in SDK v0.28.0. For details, refer to the [SDK release notes](/release-notes/sdk-releases). |
| 244 | + |
| 245 | +## Related resources |
| 246 | + |
| 247 | +- [View a specific run](/models/runs/view-logged-runs) in the W&B App or LEET. |
| 248 | +- [Keyboard shortcuts](/models/app/keyboard-shortcuts) for the W&B App and LEET. |
| 249 | +- [`wandb leet`](/models/ref/cli/wandb-leet) command reference. |
| 250 | +- [SDK release notes](/release-notes/sdk-releases), including LEET changes. |
0 commit comments