diff --git a/website/docs/getting-started/quickstart.md b/website/docs/getting-started/quickstart.md index 80eaf3589ca..2149c1063c3 100644 --- a/website/docs/getting-started/quickstart.md +++ b/website/docs/getting-started/quickstart.md @@ -88,6 +88,16 @@ The single most important setup step. Use `hermes model` to walk through the cho hermes model ``` +:::tip Easiest path: Nous Portal +One subscription covers 300+ models plus the [Tool Gateway](../user-guide/features/tool-gateway.md) (web search, image generation, TTS, cloud browser). On a fresh install: + +```bash +hermes setup --portal +``` + +That logs you in, sets Nous as your provider, and turns on the Tool Gateway in one command. +::: + Good defaults: | Provider | What it is | How to set up | diff --git a/website/docs/reference/cli-commands.md b/website/docs/reference/cli-commands.md index f2852722c5c..448fd6833eb 100644 --- a/website/docs/reference/cli-commands.md +++ b/website/docs/reference/cli-commands.md @@ -68,6 +68,7 @@ hermes [global-options] [subcommand/options] | `hermes acp` | Run Hermes as an ACP server for editor integration. | | `hermes mcp` | Manage MCP server configurations and run Hermes as an MCP server. | | `hermes plugins` | Manage Hermes Agent plugins (install, enable, disable, remove). | +| `hermes portal` | Nous Portal status, subscription link, and Tool Gateway routing. See [Tool Gateway](../user-guide/features/tool-gateway.md). | | `hermes tools` | Configure enabled tools per platform. | | `hermes computer-use` | Install or check the cua-driver backend (macOS Computer Use). | | `hermes sessions` | Browse, export, prune, rename, and delete sessions. | @@ -257,7 +258,7 @@ the full guide, supported languages, and configuration knobs. ## `hermes setup` ```bash -hermes setup [model|tts|terminal|gateway|tools|agent] [--non-interactive] [--reset] [--quick] [--reconfigure] +hermes setup [model|tts|terminal|gateway|tools|agent] [--non-interactive] [--reset] [--quick] [--reconfigure] [--portal] ``` **First run:** launches the first-time wizard. @@ -282,6 +283,23 @@ Options: | `--non-interactive` | Use defaults / environment values without prompts. | | `--reset` | Reset configuration to defaults before setup. | | `--reconfigure` | Backwards-compat alias — bare `hermes setup` on an existing install now does this by default. | +| `--portal` | One-shot Nous Portal setup: log in via OAuth, set Nous as the inference provider, and opt into the [Tool Gateway](../user-guide/features/tool-gateway.md). Skips the rest of the wizard. | + +## `hermes portal` + +```bash +hermes portal [status|open|tools] +``` + +Inspect Nous Portal auth, Tool Gateway routing, and reach the subscription page. Subcommand-less invocation runs `status`. + +| Subcommand | Description | +|------------|-------------| +| `status` (default) | Portal auth state + per-tool Tool Gateway routing summary. Also shown when no subcommand is given. | +| `open` | Open `portal.nousresearch.com/manage-subscription` in your default browser. | +| `tools` | List every Tool Gateway partner (Firecrawl, FAL, OpenAI TTS, Browser Use, Modal) and which are routed via Nous. | + +For configuration of the gateway itself, see [Tool Gateway](../user-guide/features/tool-gateway.md). For the one-shot setup path, see `hermes setup --portal` above. ## `hermes whatsapp` diff --git a/website/docs/user-guide/features/browser.md b/website/docs/user-guide/features/browser.md index 296572f22f9..e98ad522b1a 100644 --- a/website/docs/user-guide/features/browser.md +++ b/website/docs/user-guide/features/browser.md @@ -34,7 +34,7 @@ Key capabilities: ## Setup :::tip Nous Subscribers -If you have a paid [Nous Portal](https://portal.nousresearch.com) subscription, you can use browser automation through the **[Tool Gateway](tool-gateway.md)** without any separate API keys. Run `hermes model` or `hermes tools` to enable it. +If you have a paid [Nous Portal](https://portal.nousresearch.com) subscription, you can use browser automation through the **[Tool Gateway](tool-gateway.md)** without any separate API keys. New installs can run `hermes setup --portal` to log in and turn on every gateway tool at once; existing installs can pick **Nous Subscription** as the browser provider via `hermes model` or `hermes tools`. ::: ### Browserbase cloud mode diff --git a/website/docs/user-guide/features/image-generation.md b/website/docs/user-guide/features/image-generation.md index 118459429e3..73fa4b334fc 100644 --- a/website/docs/user-guide/features/image-generation.md +++ b/website/docs/user-guide/features/image-generation.md @@ -28,7 +28,7 @@ Prices are FAL's pricing at time of writing; check [fal.ai](https://fal.ai/) for ## Setup :::tip Nous Subscribers -If you have a paid [Nous Portal](https://portal.nousresearch.com) subscription, you can use image generation through the **[Tool Gateway](tool-gateway.md)** without a FAL API key. Your model selection persists across both paths. +If you have a paid [Nous Portal](https://portal.nousresearch.com) subscription, you can use image generation through the **[Tool Gateway](tool-gateway.md)** without a FAL API key. Your model selection persists across both paths. New installs can run `hermes setup --portal` to log in and turn on every gateway tool at once; existing installs can pick **Nous Subscription** as the image-gen backend via `hermes tools`. If the managed gateway returns `HTTP 4xx` for a specific model, that model isn't yet proxied on the portal side — the agent will tell you so, with remediation steps (set `FAL_KEY` for direct access, or pick a different model). ::: diff --git a/website/docs/user-guide/features/tool-gateway.md b/website/docs/user-guide/features/tool-gateway.md index 91a560b92e6..6e7a528d736 100644 --- a/website/docs/user-guide/features/tool-gateway.md +++ b/website/docs/user-guide/features/tool-gateway.md @@ -39,8 +39,16 @@ Bring your own keys anytime — per-tool, whenever you want to. The gateway isn' ## Get started +The fastest path for a fresh install: + ```bash -hermes model # Pick Nous Portal as your provider +hermes setup --portal # Nous OAuth, set Nous as provider, and turn on the Tool Gateway in one go +``` + +Already have Hermes configured? Just switch your provider: + +```bash +hermes model # Pick Nous Portal — Hermes will offer to turn on the Tool Gateway ``` When you select Nous Portal, Hermes offers to turn on the Tool Gateway. Accept, and you're done — every supported tool is live on the next run. @@ -48,10 +56,12 @@ When you select Nous Portal, Hermes offers to turn on the Tool Gateway. Accept, Check what's active at any time: ```bash -hermes status +hermes portal status # Portal auth + Tool Gateway routing summary +hermes portal tools # Gateway catalog with current routing per tool +hermes status # Full system status (Tool Gateway is one section) ``` -You'll see a section like: +`hermes portal status` shows a section like: ``` ◆ Nous Tool Gateway diff --git a/website/docs/user-guide/features/tts.md b/website/docs/user-guide/features/tts.md index 5dbcc36b19d..d65a9f4031b 100644 --- a/website/docs/user-guide/features/tts.md +++ b/website/docs/user-guide/features/tts.md @@ -9,7 +9,7 @@ description: "Text-to-speech and voice message transcription across all platform Hermes Agent supports both text-to-speech output and voice message transcription across all messaging platforms. :::tip Nous Subscribers -If you have a paid [Nous Portal](https://portal.nousresearch.com) subscription, OpenAI TTS is available through the **[Tool Gateway](tool-gateway.md)** without a separate OpenAI API key. Run `hermes model` or `hermes tools` to enable it. +If you have a paid [Nous Portal](https://portal.nousresearch.com) subscription, OpenAI TTS is available through the **[Tool Gateway](tool-gateway.md)** without a separate OpenAI API key. New installs can run `hermes setup --portal` to log in and turn on every gateway tool at once; existing installs can pick **Nous Subscription** for just TTS via `hermes model` or `hermes tools`. ::: ## Text-to-Speech diff --git a/website/docs/user-guide/features/web-search.md b/website/docs/user-guide/features/web-search.md index 42877025225..9cda2ee7826 100644 --- a/website/docs/user-guide/features/web-search.md +++ b/website/docs/user-guide/features/web-search.md @@ -32,7 +32,7 @@ Brave Search, DDGS, and xAI are **search-only** — pair any of them with Firecr **Per-capability split:** you can use different providers for search and extract independently — for example SearXNG (free) for search and Firecrawl for extract. See [Per-capability configuration](#per-capability-configuration) below. :::tip Nous Subscribers -If you have a paid [Nous Portal](https://portal.nousresearch.com) subscription, web search and extract are available through the **[Tool Gateway](tool-gateway.md)** via managed Firecrawl — no API key needed. Run `hermes tools` to enable it. +If you have a paid [Nous Portal](https://portal.nousresearch.com) subscription, web search and extract are available through the **[Tool Gateway](tool-gateway.md)** via managed Firecrawl — no API key needed. New installs can run `hermes setup --portal` to log in and turn on all gateway tools at once; existing installs can flip just web via `hermes tools`. ::: ---