You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
refactor(tui): rebrand Gator to Term/NemoClaw (#134)
Closes#130
Rename the TUI from "Gator" to use generic naming:
- CLI subcommand: `nemoclaw gator` → `nemoclaw term`
- TUI title bar: "Gator" → "NemoClaw"
- Docs/skills: "Gator" → "the TUI" or "NemoClaw TUI"
- File renames: gator.toml → term.toml, gator.md → tui.md
- Remove dead link to nonexistent plans/gator-tui.md
Co-authored-by: John Myers <johntmyers@users.noreply.github.com>
Copy file name to clipboardExpand all lines: .agents/skills/tui-development/SKILL.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,17 @@
1
1
---
2
2
name: tui-development
3
-
description: Guide for developing the "Gator" TUI — a ratatui-based terminal UI for the NemoClaw platform. Covers architecture, navigation, data fetching, theming, UX conventions, and development workflow. Trigger keywords - gator, TUI, terminal UI, ratatui, navigator-tui, tui development, gator feature, gator bug.
3
+
description: Guide for developing the NemoClaw TUI — a ratatui-based terminal UI for the NemoClaw platform. Covers architecture, navigation, data fetching, theming, UX conventions, and development workflow. Trigger keywords - term, TUI, terminal UI, ratatui, navigator-tui, tui development, tui feature, tui bug.
4
4
---
5
5
6
-
# Gator TUI Development Guide
6
+
# NemoClaw TUI Development Guide
7
7
8
-
Comprehensive reference for any agent working on the Gator TUI.
8
+
Comprehensive reference for any agent working on the NemoClaw TUI.
9
9
10
10
## 1. Overview
11
11
12
-
Gator is a ratatui-based terminal UI for the NemoClaw platform. It provides a keyboard-driven interface for managing clusters, sandboxes, and logs — the same operations available via the `nemoclaw` CLI, but with a live, interactive dashboard.
12
+
The NemoClaw TUI is a ratatui-based terminal UI for the NemoClaw platform. It provides a keyboard-driven interface for managing clusters, sandboxes, and logs — the same operations available via the `nemoclaw` CLI, but with a live, interactive dashboard.
13
13
14
-
-**Launched via:**`nemoclaw gator` or `mise run gator`
14
+
-**Launched via:**`nemoclaw term` or `mise run term`
Copy file name to clipboardExpand all lines: architecture/tui.md
+20-22Lines changed: 20 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
-
# Gator: NemoClaw TUI
1
+
# NemoClaw TUI
2
2
3
-
Gator is a terminal user interface for NemoClaw, inspired by [k9s](https://k9scli.io/). Instead of typing individual CLI commands to check cluster health, list sandboxes, and manage resources, Gator gives you a real-time, keyboard-driven dashboard — everything updates automatically and you navigate with a few keystrokes.
3
+
The NemoClaw TUI is a terminal user interface for NemoClaw, inspired by [k9s](https://k9scli.io/). Instead of typing individual CLI commands to check cluster health, list sandboxes, and manage resources, the TUI gives you a real-time, keyboard-driven dashboard — everything updates automatically and you navigate with a few keystrokes.
4
4
5
-
## Launching Gator
5
+
## Launching the TUI
6
6
7
-
Gator is a subcommand of the NemoClaw CLI, so it inherits all your existing configuration — cluster selection, TLS settings, and verbosity flags all work the same way.
7
+
The TUI is a subcommand of the NemoClaw CLI, so it inherits all your existing configuration — cluster selection, TLS settings, and verbosity flags all work the same way.
8
8
9
9
```bash
10
-
nemoclaw gator# launch against the active cluster
11
-
nav gator# dev alias (builds from source)
12
-
nav gator --cluster prod # target a specific cluster
13
-
NEMOCLAW_CLUSTER=prod nav gator# same thing, via environment variable
10
+
nemoclaw term# launch against the active cluster
11
+
nav term# dev alias (builds from source)
12
+
nav term --cluster prod # target a specific cluster
13
+
NEMOCLAW_CLUSTER=prod nav term# same thing, via environment variable
14
14
```
15
15
16
16
Cluster resolution follows the same priority as the rest of the CLI:
@@ -23,11 +23,11 @@ No separate configuration files or authentication are needed.
23
23
24
24
## Screen Layout
25
25
26
-
Gator divides the terminal into four horizontal regions:
26
+
The TUI divides the terminal into four horizontal regions:
-**Title bar** — shows the Gator logo, cluster name, current view, and live cluster health status.
42
+
-**Title bar** — shows the NemoClaw logo, cluster name, current view, and live cluster health status.
43
43
-**Main area** — the active view (Dashboard or Sandboxes).
44
44
-**Navigation bar** — lists available views with their shortcut keys, plus Help and Quit.
45
45
-**Command bar** — appears when you press `:` to type a command (like vim).
@@ -84,7 +84,7 @@ When there are no sandboxes, the view displays: *"No sandboxes found."*
84
84
85
85
## Keyboard Controls
86
86
87
-
Gator has two input modes: **Normal** (default) and **Command** (activated by pressing `:`).
87
+
The TUI has two input modes: **Normal** (default) and **Command** (activated by pressing `:`).
88
88
89
89
### Normal Mode
90
90
@@ -95,7 +95,7 @@ Gator has two input modes: **Normal** (default) and **Command** (activated by pr
95
95
|`j` or `↓`| Move selection down |
96
96
|`k` or `↑`| Move selection up |
97
97
|`:`| Enter command mode |
98
-
|`q`| Quit Gator |
98
+
|`q`| Quit |
99
99
|`Ctrl+C`| Force quit |
100
100
101
101
### Command Mode
@@ -104,19 +104,19 @@ Press `:` to open the command bar at the bottom of the screen. Type a command an
104
104
105
105
| Command | Action |
106
106
|---------|--------|
107
-
|`quit` or `q`| Quit Gator |
107
+
|`quit` or `q`| Quit |
108
108
|`dashboard` or `1`| Switch to Dashboard view |
109
109
|`sandboxes` or `2`| Switch to Sandboxes view |
110
110
111
111
Press `Esc` to cancel and return to Normal mode. `Backspace` deletes characters as you type.
112
112
113
113
## Data Refresh
114
114
115
-
Gator automatically polls the cluster every **2 seconds**. Both cluster health and the sandbox list update on each tick, so the display stays current without manual refreshing. This uses the same gRPC calls as the CLI — no additional server-side setup is required.
115
+
The TUI automatically polls the cluster every **2 seconds**. Both cluster health and the sandbox list update on each tick, so the display stays current without manual refreshing. This uses the same gRPC calls as the CLI — no additional server-side setup is required.
116
116
117
117
## Theme
118
118
119
-
Gator uses a dark terminal theme based on the NVIDIA brand palette:
119
+
The TUI uses a dark terminal theme based on the NVIDIA brand palette:
120
120
121
121
-**Background**: Black — the standard terminal background.
122
122
-**Text**: White for primary content, dimmed white for labels and secondary information.
@@ -128,30 +128,28 @@ The title bar uses white text on an Everglade background to visually anchor the
128
128
129
129
## Port Forwarding
130
130
131
-
Gator supports creating sandboxes with port forwarding directly from the create modal. When creating a sandbox, you can specify ports to forward in the **Ports** field (comma-separated, e.g., `8080,3000`). After the sandbox reaches `Ready` state, Gator automatically spawns background SSH tunnels (`ssh -N -f -L <port>:127.0.0.1:<port>`) for each specified port.
131
+
The TUI supports creating sandboxes with port forwarding directly from the create modal. When creating a sandbox, you can specify ports to forward in the **Ports** field (comma-separated, e.g., `8080,3000`). After the sandbox reaches `Ready` state, the TUI automatically spawns background SSH tunnels (`ssh -N -f -L <port>:127.0.0.1:<port>`) for each specified port.
132
132
133
133
Forwarded ports are displayed in the **NOTES** column of the sandbox table as `fwd:8080,3000` and in the **Forwards** row of the sandbox detail view.
134
134
135
135
Port forwarding lifecycle:
136
-
-**On create**: Gator polls for sandbox readiness (up to 30 attempts at 2-second intervals), then spawns SSH tunnels.
136
+
-**On create**: The TUI polls for sandbox readiness (up to 30 attempts at 2-second intervals), then spawns SSH tunnels.
137
137
-**On delete**: Any active forwards for the sandbox are automatically stopped before deletion.
138
138
-**PID tracking**: Forward PIDs are stored in `~/.config/nemoclaw/forwards/<name>-<port>.pid`, shared with the CLI.
139
139
140
140
The forwarding implementation lives in `navigator-core::forward`, shared between the CLI and TUI.
141
141
142
142
## What is Not Yet Available
143
143
144
-
Gator is in its initial phase. The following features are planned but not yet implemented:
144
+
The TUI is in its initial phase. The following features are planned but not yet implemented:
145
145
146
146
-**Inference and provider views** — browsing inference routes and provider configurations.
147
147
-**Help overlay** — the `?` key is shown in the nav bar but does not open a help screen yet.
148
148
-**Command bar autocomplete** — the command bar accepts text but does not offer suggestions.
149
149
-**Filtering and search** — no `/` search within views yet.
150
150
151
-
See the [Gator design plan](plans/gator-tui.md) for the full roadmap, including mockups and future phases.
152
-
153
151
## Crate Structure
154
152
155
-
The TUI lives in `crates/navigator-tui/`, a separate workspace crate. The CLI crate (`crates/navigator-cli/`) depends on it and launches it via the `Gator` command variant in the `Commands` enum. This keeps TUI-specific dependencies (ratatui, crossterm) out of the CLI when not in use.
153
+
The TUI lives in `crates/navigator-tui/`, a separate workspace crate. The CLI crate (`crates/navigator-cli/`) depends on it and launches it via the `Term` command variant in the `Commands` enum. This keeps TUI-specific dependencies (ratatui, crossterm) out of the CLI when not in use.
156
154
157
155
The `navigator-tui` crate depends on `navigator-core` for protobuf types, the gRPC client, and shared utilities (e.g., `navigator_core::forward` for port forwarding PID management) — it communicates with the gateway over the same gRPC channel the CLI uses.
0 commit comments