Skip to content

Commit 6acd7b2

Browse files
bpiwowarclaude
andcommitted
feat: make console TUI the default for ssh-monitor
Replace --console flag with --web flag so that the console TUI is used by default for ssh-monitor, and --web must be passed to use the web UI. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 3a7044c commit 6acd7b2

5 files changed

Lines changed: 20 additions & 18 deletions

File tree

docs/source/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ When enabled, experimaestro tracks CO2 emissions, energy consumption, and power
233233
Monitor experiments running on remote servers directly from your local machine:
234234
235235
```bash
236-
experimaestro experiments ssh-monitor user@cluster /path/to/workspace --console
236+
experimaestro experiments ssh-monitor user@cluster /path/to/workspace
237237
```
238238

239239
Features include JSON-RPC communication over SSH, on-demand file synchronization for logs, and support for both Web UI and TUI. See [Remote Monitoring via SSH](interfaces.md#remote-monitoring-via-ssh) for details.

docs/source/cli.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ experimaestro experiments ssh-monitor HOST REMOTE_WORKDIR [OPTIONS]
275275

276276
| Option | Description |
277277
|--------|-------------|
278-
| `--console` | Use terminal TUI instead of web UI |
278+
| `--web` | Use web UI instead of console TUI (console is default) |
279279
| `--port PORT` | Port for local web server (default: 12345) |
280280
| `--remote-xpm PATH` | Path to experimaestro on remote host |
281281
| `-o, --ssh-option OPT` | Additional SSH options (can be repeated) |
@@ -287,14 +287,14 @@ experimaestro experiments ssh-monitor HOST REMOTE_WORKDIR [OPTIONS]
287287
Examples:
288288

289289
```bash
290-
# Basic monitoring with web UI
290+
# Basic monitoring (console TUI by default)
291291
experimaestro experiments ssh-monitor myserver /home/user/experiments
292292

293-
# With console TUI
294-
experimaestro experiments ssh-monitor user@host /workspace --console
293+
# With web UI
294+
experimaestro experiments ssh-monitor user@host /workspace --web
295295

296296
# Using workspace SSH settings from settings.yaml
297-
experimaestro experiments ssh-monitor --workspace my-cluster --console
297+
experimaestro experiments ssh-monitor --workspace my-cluster
298298

299299
# With shell init for HPC environments
300300
experimaestro experiments ssh-monitor host /workspace --remote-shell-init "source /etc/profile; module load python/3.10"

docs/source/interfaces.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -218,11 +218,11 @@ experimaestro experiments ssh-monitor HOST REMOTE_WORKDIR [OPTIONS]
218218
### Examples
219219

220220
```bash
221-
# Basic SSH monitoring with web UI
221+
# Basic SSH monitoring (console TUI by default)
222222
experimaestro experiments ssh-monitor myserver /home/user/experiments
223223

224-
# With console TUI instead of web UI
225-
experimaestro experiments ssh-monitor user@cluster.example.com /scratch/experiments --console
224+
# With web UI instead of console TUI
225+
experimaestro experiments ssh-monitor user@cluster.example.com /scratch/experiments --web
226226

227227
# Custom port for web interface
228228
experimaestro experiments ssh-monitor myserver /workspace --port 8080
@@ -238,7 +238,7 @@ experimaestro experiments ssh-monitor myserver /workspace --remote-xpm /opt/cond
238238

239239
| Option | Description |
240240
|--------|-------------|
241-
| `--console` | Use terminal TUI instead of web UI |
241+
| `--web` | Use web UI instead of console TUI (console is default) |
242242
| `--port PORT` | Port for local web server (default: 12345) |
243243
| `--remote-xpm PATH` | Path to experimaestro executable on remote host |
244244
| `-o, --ssh-option OPT` | Additional SSH options (can be repeated) |
@@ -272,7 +272,7 @@ workspaces:
272272
Then use `--workspace` to load settings automatically:
273273

274274
```bash
275-
experimaestro experiments ssh-monitor --workspace my-cluster --console
275+
experimaestro experiments ssh-monitor --workspace my-cluster
276276
```
277277

278278
See [Remote Workspaces (SSH)](settings.md#remote-workspaces-ssh) for all available settings.

docs/source/settings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,10 +117,10 @@ Once configured, use `--workspace` with `ssh-monitor` to avoid repeating host/op
117117

118118
```bash
119119
# All settings come from the workspace configuration
120-
experimaestro experiments ssh-monitor --workspace my-cluster --console
120+
experimaestro experiments ssh-monitor --workspace my-cluster
121121
122122
# CLI flags override workspace settings
123-
experimaestro experiments ssh-monitor --workspace my-cluster --uv-offline --console
123+
experimaestro experiments ssh-monitor --workspace my-cluster --uv-offline
124124
```
125125

126126
All SSH settings can be overridden by CLI flags (`--remote-shell-init`, `--uv-offline`,

src/experimaestro/cli/__init__.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -634,7 +634,9 @@ def monitor(
634634
@experiments.command("ssh-monitor")
635635
@click.argument("host", type=str, required=False, default=None)
636636
@click.argument("remote_workdir", type=str, required=False, default=None)
637-
@click.option("--console", is_flag=True, help="Use console TUI instead of web UI")
637+
@click.option(
638+
"--web", is_flag=True, help="Use web UI instead of console TUI (default is console)"
639+
)
638640
@click.option(
639641
"--events-viewer",
640642
is_flag=True,
@@ -713,7 +715,7 @@ def monitor(
713715
def ssh_monitor(
714716
host: str | None,
715717
remote_workdir: str | None,
716-
console: bool,
718+
web: bool,
717719
events_viewer: bool,
718720
events_format: str,
719721
no_progress: bool,
@@ -739,8 +741,8 @@ def ssh_monitor(
739741
740742
Examples:
741743
experimaestro experiments ssh-monitor myserver /path/to/workspace
742-
experimaestro experiments ssh-monitor user@host /workspace --console
743-
experimaestro experiments ssh-monitor --workspace my-cluster --console
744+
experimaestro experiments ssh-monitor user@host /workspace --web
745+
experimaestro experiments ssh-monitor --workspace my-cluster
744746
experimaestro experiments ssh-monitor host /workspace --remote-shell-init "source /etc/profile; module load python/3.10"
745747
experimaestro experiments ssh-monitor host /workspace --uv-offline --remote-python python3
746748
"""
@@ -827,7 +829,7 @@ def ssh_monitor(
827829
_run_monitor_ui(
828830
state_provider,
829831
state_provider.local_cache_dir,
830-
console,
832+
not web,
831833
port,
832834
title=effective_host,
833835
events_viewer=events_viewer,

0 commit comments

Comments
 (0)