admin/Hermes-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: format README tables and spacing

Browse Source 
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
ekko
2026-04-13 15:22:12 +08:00
parent 11e0b65934
commit cf41d790f4
1 changed files with 18 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+18 -8
View File
@@ -28,14 +28,14 @@ Open http://localhost:8648
### CLI Commands ### CLI Commands
| Command | Description | | Command | Description |
|---------|-------------| | --------------------------------- | --------------------------------- |
| `hermes-web-ui start` | Start in background (daemon mode) | | `hermes-web-ui start` | Start in background (daemon mode) |
| `hermes-web-ui start --port 9000` | Start on custom port | | `hermes-web-ui start --port 9000` | Start on custom port |
| `hermes-web-ui stop` | Stop background process | | `hermes-web-ui stop` | Stop background process |
| `hermes-web-ui restart` | Restart background process | | `hermes-web-ui restart` | Restart background process |
| `hermes-web-ui status` | Check if running | | `hermes-web-ui status` | Check if running |
| `hermes-web-ui` | Run in foreground (for debugging) | | `hermes-web-ui` | Run in foreground (for debugging) |
### Auto Configuration ### Auto Configuration
@@ -51,6 +51,7 @@ npm run dev
``` ```
This starts: This starts:
- Frontend: http://localhost:5173 - Frontend: http://localhost:5173
- BFF Server: http://localhost:8648 (proxies to Hermes on 8642) - BFF Server: http://localhost:8648 (proxies to Hermes on 8642)
@@ -121,6 +122,7 @@ hermes-web-ui/
## Features ## Features
### Chat ### Chat
- Async Run + SSE event streaming via BFF proxy - Async Run + SSE event streaming via BFF proxy
- Session management via Hermes CLI - Session management via Hermes CLI
- Multi-session switching with message history - Multi-session switching with message history
@@ -134,6 +136,7 @@ hermes-web-ui/
- Per-session model display (badge in chat header and session list) - Per-session model display (badge in chat header and session list)
### Platform Channels ### Platform Channels
- Unified channel configuration page (Telegram, Discord, Slack, WhatsApp, Matrix, Feishu, WeChat, WeCom) - Unified channel configuration page (Telegram, Discord, Slack, WhatsApp, Matrix, Feishu, WeChat, WeCom)
- Credential management — writes to `~/.hermes/.env` (matching `hermes gateway setup` behavior) - Credential management — writes to `~/.hermes/.env` (matching `hermes gateway setup` behavior)
- Channel behavior settings — writes to `~/.hermes/config.yaml` - Channel behavior settings — writes to `~/.hermes/config.yaml`
@@ -142,6 +145,7 @@ hermes-web-ui/
- Per-platform configured/unconfigured status detection - Per-platform configured/unconfigured status detection
### Model Management ### Model Management
- Automatically reads credential pool from `~/.hermes/auth.json` - Automatically reads credential pool from `~/.hermes/auth.json`
- Fetches available models from each provider endpoint (`/v1/models`) - Fetches available models from each provider endpoint (`/v1/models`)
- Groups models by provider (e.g. zai, subrouter.ai) - Groups models by provider (e.g. zai, subrouter.ai)
@@ -150,6 +154,7 @@ hermes-web-ui/
- Error handling: parallel fetching, per-provider timeout, fallback to config.yaml parsing - Error handling: parallel fetching, per-provider timeout, fallback to config.yaml parsing
### Settings ### Settings
- Display settings (streaming, compact mode, reasoning, cost, etc.) - Display settings (streaming, compact mode, reasoning, cost, etc.)
- Agent settings (max turns, timeout, tool enforcement) - Agent settings (max turns, timeout, tool enforcement)
- Memory settings (enable/disable, char limits) - Memory settings (enable/disable, char limits)
@@ -158,22 +163,26 @@ hermes-web-ui/
- API server settings - API server settings
### Scheduled Jobs ### Scheduled Jobs
- Job list view (including paused/disabled jobs) - Job list view (including paused/disabled jobs)
- Create, edit, pause, resume, and delete jobs - Create, edit, pause, resume, and delete jobs
- Trigger immediate job execution - Trigger immediate job execution
- Cron expression quick presets - Cron expression quick presets
### Skills & Memory ### Skills & Memory
- Browse and search installed skills - Browse and search installed skills
- View skill details and attached files - View skill details and attached files
- User notes and profile management - User notes and profile management
### Logs ### Logs
- View Hermes agent/gateway/error logs - View Hermes agent/gateway/error logs
- Filter by log level, log file, and search keyword - Filter by log level, log file, and search keyword
- Structured log parsing with HTTP access log highlighting - Structured log parsing with HTTP access log highlighting
### Other ### Other
- Internationalization — auto-detect browser language, manual toggle between Chinese and English - Internationalization — auto-detect browser language, manual toggle between Chinese and English
- Real-time connection status monitoring - Real-time connection status monitoring
- Hermes version display in sidebar - Hermes version display in sidebar
@@ -194,6 +203,7 @@ Browser → BFF (Koa, :8648) → Hermes API (:8642)
``` ```
The BFF layer handles: The BFF layer handles:
- API proxy to Hermes (with header forwarding) - API proxy to Hermes (with header forwarding)
- SSE streaming passthrough - SSE streaming passthrough
- File upload to temp directory - File upload to temp directory