mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-04-28 06:51:16 +08:00
docs: remove hermes setup from install flow, point to hermes model/tools instead
The installer already handles full setup (provider config, etc.), so telling users to run 'hermes setup' post-install is redundant and confusing. Updated all docs to reflect the correct flow: 1. Run the installer (handles everything including provider setup) 2. Use 'hermes model', 'hermes tools', 'hermes gateway setup' to reconfigure individual settings later Files updated: - README.md: removed setup from quick install & getting started - installation.md: updated post-install, manual step 9, troubleshooting - quickstart.md: updated provider section & quick reference table - cli-commands.md: updated hermes setup description - faq.md: replaced hermes setup references with specific commands
This commit is contained in:
@@ -41,7 +41,6 @@ After installation:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
source ~/.bashrc # reload shell (or: source ~/.zshrc)
|
source ~/.bashrc # reload shell (or: source ~/.zshrc)
|
||||||
hermes setup # configure your LLM provider
|
|
||||||
hermes # start chatting!
|
hermes # start chatting!
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -52,7 +51,7 @@ hermes # start chatting!
|
|||||||
```bash
|
```bash
|
||||||
hermes # Interactive CLI — start a conversation
|
hermes # Interactive CLI — start a conversation
|
||||||
hermes model # Switch provider or model
|
hermes model # Switch provider or model
|
||||||
hermes setup # Re-run the setup wizard
|
hermes tools # Configure which tools are enabled
|
||||||
hermes gateway # Start the messaging gateway (Telegram, Discord, etc.)
|
hermes gateway # Start the messaging gateway (Telegram, Discord, etc.)
|
||||||
hermes update # Update to the latest version
|
hermes update # Update to the latest version
|
||||||
hermes doctor # Diagnose any issues
|
hermes doctor # Diagnose any issues
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ Native Windows is **not supported**. Please install [WSL2](https://learn.microso
|
|||||||
|
|
||||||
### What the Installer Does
|
### What the Installer Does
|
||||||
|
|
||||||
The installer handles everything automatically — all dependencies (Python, Node.js, ripgrep, ffmpeg), the repo clone, virtual environment, and global `hermes` command setup. It finishes by running the interactive setup wizard to configure your LLM provider.
|
The installer handles everything automatically — all dependencies (Python, Node.js, ripgrep, ffmpeg), the repo clone, virtual environment, global `hermes` command setup, and LLM provider configuration. By the end, you're ready to chat.
|
||||||
|
|
||||||
### After Installation
|
### After Installation
|
||||||
|
|
||||||
@@ -30,10 +30,17 @@ Reload your shell and start chatting:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
source ~/.bashrc # or: source ~/.zshrc
|
source ~/.bashrc # or: source ~/.zshrc
|
||||||
hermes setup # Configure API keys (if you skipped during install)
|
|
||||||
hermes # Start chatting!
|
hermes # Start chatting!
|
||||||
```
|
```
|
||||||
|
|
||||||
|
To reconfigure individual settings later, use the dedicated commands:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hermes model # Switch provider or model
|
||||||
|
hermes tools # Configure which tools are enabled
|
||||||
|
hermes gateway setup # Set up messaging platforms
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
@@ -192,10 +199,10 @@ echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc && source ~/.zshrc
|
|||||||
fish_add_path $HOME/.local/bin
|
fish_add_path $HOME/.local/bin
|
||||||
```
|
```
|
||||||
|
|
||||||
### Step 9: Run the Setup Wizard (Optional)
|
### Step 9: Configure Your Provider
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
hermes setup
|
hermes model # Select your LLM provider and model
|
||||||
```
|
```
|
||||||
|
|
||||||
### Step 10: Verify the Installation
|
### Step 10: Verify the Installation
|
||||||
@@ -253,7 +260,7 @@ hermes
|
|||||||
| Problem | Solution |
|
| Problem | Solution |
|
||||||
|---------|----------|
|
|---------|----------|
|
||||||
| `hermes: command not found` | Reload your shell (`source ~/.bashrc`) or check PATH |
|
| `hermes: command not found` | Reload your shell (`source ~/.bashrc`) or check PATH |
|
||||||
| `API key not set` | Run `hermes setup` or `hermes config set OPENROUTER_API_KEY your_key` |
|
| `API key not set` | Run `hermes model` to configure your provider, or `hermes config set OPENROUTER_API_KEY your_key` |
|
||||||
| Missing config after update | Run `hermes config check` then `hermes config migrate` |
|
| Missing config after update | Run `hermes config check` then `hermes config migrate` |
|
||||||
|
|
||||||
For more diagnostics, run `hermes doctor` — it will tell you exactly what's missing and how to fix it.
|
For more diagnostics, run `hermes doctor` — it will tell you exactly what's missing and how to fix it.
|
||||||
|
|||||||
@@ -29,10 +29,10 @@ source ~/.bashrc # or source ~/.zshrc
|
|||||||
|
|
||||||
## 2. Set Up a Provider
|
## 2. Set Up a Provider
|
||||||
|
|
||||||
The installer runs the setup wizard automatically. If you skipped it, run:
|
The installer configures your LLM provider automatically. To change it later, run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
hermes setup
|
hermes model
|
||||||
```
|
```
|
||||||
|
|
||||||
This walks you through selecting an inference provider:
|
This walks you through selecting an inference provider:
|
||||||
@@ -160,7 +160,6 @@ mcp_servers:
|
|||||||
| Command | Description |
|
| Command | Description |
|
||||||
|---------|-------------|
|
|---------|-------------|
|
||||||
| `hermes` | Start chatting |
|
| `hermes` | Start chatting |
|
||||||
| `hermes setup` | Configure providers and settings |
|
|
||||||
| `hermes model` | Switch provider or model |
|
| `hermes model` | Switch provider or model |
|
||||||
| `hermes tools` | Configure which tools are enabled per platform |
|
| `hermes tools` | Configure which tools are enabled per platform |
|
||||||
| `hermes doctor` | Diagnose issues |
|
| `hermes doctor` | Diagnose issues |
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ These are commands you run from your shell.
|
|||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|---------|-------------|
|
|---------|-------------|
|
||||||
| `hermes setup` | Full setup wizard (provider, terminal, messaging) |
|
| `hermes setup` | Full setup wizard (runs automatically during install) |
|
||||||
| `hermes config` | View current configuration |
|
| `hermes config` | View current configuration |
|
||||||
| `hermes config edit` | Open config.yaml in your editor |
|
| `hermes config edit` | Open config.yaml in your editor |
|
||||||
| `hermes config set KEY VAL` | Set a specific value |
|
| `hermes config set KEY VAL` | Set a specific value |
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ Hermes Agent works with any OpenAI-compatible API. Supported providers include:
|
|||||||
- **MiniMax** — global and China endpoints
|
- **MiniMax** — global and China endpoints
|
||||||
- **Local models** — via [Ollama](https://ollama.com/), [vLLM](https://docs.vllm.ai/), [llama.cpp](https://github.com/ggerganov/llama.cpp), [SGLang](https://github.com/sgl-project/sglang), or any OpenAI-compatible server
|
- **Local models** — via [Ollama](https://ollama.com/), [vLLM](https://docs.vllm.ai/), [llama.cpp](https://github.com/ggerganov/llama.cpp), [SGLang](https://github.com/sgl-project/sglang), or any OpenAI-compatible server
|
||||||
|
|
||||||
Set your provider with `hermes setup` or by editing `~/.hermes/.env`. See the [Environment Variables](./environment-variables.md) reference for all provider keys.
|
Set your provider with `hermes model` or by editing `~/.hermes/.env`. See the [Environment Variables](./environment-variables.md) reference for all provider keys.
|
||||||
|
|
||||||
### Does it work on Windows?
|
### Does it work on Windows?
|
||||||
|
|
||||||
@@ -160,8 +160,8 @@ curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scri
|
|||||||
# Check which keys are set
|
# Check which keys are set
|
||||||
hermes config get OPENROUTER_API_KEY
|
hermes config get OPENROUTER_API_KEY
|
||||||
|
|
||||||
# Re-run interactive setup
|
# Re-configure your provider
|
||||||
hermes setup
|
hermes model
|
||||||
|
|
||||||
# Or set directly
|
# Or set directly
|
||||||
hermes config set OPENROUTER_API_KEY sk-or-v1-xxxxxxxxxxxx
|
hermes config set OPENROUTER_API_KEY sk-or-v1-xxxxxxxxxxxx
|
||||||
@@ -279,7 +279,7 @@ hermes gateway logs
|
|||||||
**Cause:** Network issues, bot token expired, or platform webhook misconfiguration.
|
**Cause:** Network issues, bot token expired, or platform webhook misconfiguration.
|
||||||
|
|
||||||
**Solution:**
|
**Solution:**
|
||||||
- Verify your bot token is valid with `hermes setup`
|
- Verify your bot token is valid with `hermes gateway setup`
|
||||||
- Check gateway logs: `hermes gateway logs`
|
- Check gateway logs: `hermes gateway logs`
|
||||||
- For webhook-based platforms (Slack, WhatsApp), ensure your server is publicly accessible
|
- For webhook-based platforms (Slack, WhatsApp), ensure your server is publicly accessible
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user