mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-18 04:41:56 +00:00
docs(dashboard): clarify chat tab tui flag
This commit is contained in:
parent
c741eacd0c
commit
903ac23bc8
2 changed files with 13 additions and 1 deletions
|
|
@ -1106,13 +1106,17 @@ hermes claw migrate --source /home/user/old-openclaw
|
||||||
hermes dashboard [options]
|
hermes dashboard [options]
|
||||||
```
|
```
|
||||||
|
|
||||||
Launch the web dashboard — a browser-based UI for managing configuration, API keys, and monitoring sessions. Requires `pip install hermes-agent[web]` (FastAPI + Uvicorn). See [Web Dashboard](/docs/user-guide/features/web-dashboard) for full documentation.
|
Launch the web dashboard — a browser-based UI for managing configuration, API keys, and monitoring sessions. Requires `pip install hermes-agent[web]` (FastAPI + Uvicorn). The embedded browser Chat tab requires `--tui` plus the `pty` extra. See [Web Dashboard](/docs/user-guide/features/web-dashboard) for full documentation.
|
||||||
|
|
||||||
| Option | Default | Description |
|
| Option | Default | Description |
|
||||||
|--------|---------|-------------|
|
|--------|---------|-------------|
|
||||||
| `--port` | `9119` | Port to run the web server on |
|
| `--port` | `9119` | Port to run the web server on |
|
||||||
| `--host` | `127.0.0.1` | Bind address |
|
| `--host` | `127.0.0.1` | Bind address |
|
||||||
| `--no-open` | — | Don't auto-open the browser |
|
| `--no-open` | — | Don't auto-open the browser |
|
||||||
|
| `--tui` | off | Enable the in-browser Chat tab by running `hermes --tui` behind a PTY/WebSocket bridge. Requires `pip install 'hermes-agent[web,pty]'` and a POSIX PTY environment such as Linux, macOS, or WSL2. |
|
||||||
|
| `--insecure` | off | Allow binding to non-localhost hosts. Exposes dashboard credentials on the network; use only behind trusted network controls. |
|
||||||
|
| `--stop` | — | Stop running `hermes dashboard` processes and exit. |
|
||||||
|
| `--status` | — | List running `hermes dashboard` processes and exit. |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Default — opens browser to http://127.0.0.1:9119
|
# Default — opens browser to http://127.0.0.1:9119
|
||||||
|
|
@ -1120,6 +1124,9 @@ hermes dashboard
|
||||||
|
|
||||||
# Custom port, no browser
|
# Custom port, no browser
|
||||||
hermes dashboard --port 8080 --no-open
|
hermes dashboard --port 8080 --no-open
|
||||||
|
|
||||||
|
# Enable the browser Chat tab
|
||||||
|
hermes dashboard --tui
|
||||||
```
|
```
|
||||||
|
|
||||||
## `hermes profile`
|
## `hermes profile`
|
||||||
|
|
|
||||||
|
|
@ -35,6 +35,9 @@ hermes dashboard --host 0.0.0.0
|
||||||
|
|
||||||
# Start without opening browser
|
# Start without opening browser
|
||||||
hermes dashboard --no-open
|
hermes dashboard --no-open
|
||||||
|
|
||||||
|
# Enable the in-browser Chat tab
|
||||||
|
hermes dashboard --tui
|
||||||
```
|
```
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
@ -49,6 +52,8 @@ The `web` extra pulls in FastAPI/Uvicorn; `pty` pulls in `ptyprocess` (POSIX) or
|
||||||
|
|
||||||
When you run `hermes dashboard` without the dependencies, it will tell you what to install. If the frontend hasn't been built yet and `npm` is available, it builds automatically on first launch.
|
When you run `hermes dashboard` without the dependencies, it will tell you what to install. If the frontend hasn't been built yet and `npm` is available, it builds automatically on first launch.
|
||||||
|
|
||||||
|
The Chat tab is intentionally off for a plain `hermes dashboard` launch. Start the dashboard with `hermes dashboard --tui` or set `HERMES_DASHBOARD_TUI=1` when you want the embedded browser chat pane.
|
||||||
|
|
||||||
## Pages
|
## Pages
|
||||||
|
|
||||||
### Status
|
### Status
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue