better-dsh 0.2.5-c → 0.2.5-e

package/docs/80_upstream-docs-and-skills/hermes-dev-skill/src/docs/user-guide/features/subscription-proxy.md

@@ -1,203 +0,0 @@
----
-sidebar_position: 15
-title: "Subscription Proxy"
-description: "Use your Nous Portal subscription (or other OAuth provider) as an OpenAI-compatible endpoint for external apps"
----
-
-# Subscription Proxy
-
-The subscription proxy is a local HTTP server that lets external apps —
-OpenViking, Karakeep, Open WebUI, anything that speaks OpenAI-compatible
-chat completions — use your Hermes-managed provider subscription as their
-LLM endpoint. The proxy attaches the right credentials (refreshing them
-automatically) so the app never needs a static API key.
-
-This is different from the [API server](./api-server.md):
-
-| | API server | Subscription proxy |
-|---|---|---|
-| What it serves | Your agent (full toolset, memory, skills) | Raw model inference |
-| Use case | "Use Hermes as a chat backend" | "Use my Portal sub from another app" |
-| Auth | Your `API_SERVER_KEY` | Any bearer (proxy attaches the real one) |
-| Tool calls | Yes — the agent runs tools | No — passthrough only |
-
-Use the API server when you want the **agent** as a backend. Use the
-proxy when you just want **the model** through your subscription.
-
-## Quick Start
-
-### 1. Log into your provider (one-time)
-
-```bash
-hermes portal
-```
-
-This opens your browser for the Nous Portal OAuth flow. Hermes stores
-the refresh token in `~/.hermes/auth.json` — the same place all Hermes
-provider logins live.
-
-### 2. Start the proxy
-
-```bash
-hermes proxy start
-```
-
-```
-Starting Hermes proxy for Nous Portal
-  Listening on:  http://127.0.0.1:8645/v1
-  Forwarding to: (resolved per-request from your subscription)
-  Use any bearer token in the client — the proxy attaches your real credential.
-```
-
-Leave this running in the foreground. Use `tmux`, `nohup`, or a systemd
-unit if you want it to survive logout.
-
-### 3. Point your app at it
-
-Any OpenAI-compatible app config takes the same triple:
-
-```
-Base URL:   http://127.0.0.1:8645/v1
-API key:    anything (e.g. "sk-unused")
-Model:      Hermes-4-70B    # or Hermes-4.3-36B, Hermes-4-405B
-```
-
-The proxy ignores the `Authorization` header from your app and attaches
-your real Portal credential to the upstream request. Refreshes happen
-automatically when the bearer approaches expiry.
-
-## Available providers
-
-```bash
-hermes proxy providers
-```
-
-Currently shipped: `nous` (Nous Portal) and `xai` (xAI / Grok). More
-OAuth providers can be added by implementing the `UpstreamAdapter`
-interface in `hermes_cli/proxy/adapters/`.
-
-## Check status
-
-```bash
-hermes proxy status
-```
-
-```
-Hermes proxy upstream adapters
-
-  [nous    ] Nous Portal — ready (bearer expires 2026-05-15T06:43:21Z)
-```
-
-If you see `not logged in`, run `hermes portal`. If you see
-`credentials need attention`, your refresh token was revoked (rare —
-happens if you signed out from the Portal web UI) — just re-run
-`hermes portal`.
-
-## Allowed paths
-
-The proxy only forwards paths the upstream actually serves. For Nous
-Portal:
-
-| Path | Purpose |
-|------|---------|
-| `/v1/chat/completions` | Chat completions (streaming + non-streaming) |
-| `/v1/completions` | Legacy text completions |
-| `/v1/embeddings` | Embeddings |
-| `/v1/models` | Model list |
-
-Other paths (`/v1/images/generations`, `/v1/audio/speech`, etc.) return
-404 with a clear error pointing at the allowed paths. This keeps stray
-clients from leaking weird requests to the upstream.
-
-## Configuring OpenViking to use Portal
-
-[OpenViking](https://github.com/volcengine/OpenViking) is a context
-database that needs an LLM provider for its VLM (vision/language model
-used to extract memories) and embedding model. With the proxy, you can
-point its `vlm.api_base` at your local proxy:
-
-Edit `~/.openviking/ov.conf`:
-
-```json
-{
-  "vlm": {
-    "provider": "openai",
-    "model": "Hermes-4-70B",
-    "api_base": "http://127.0.0.1:8645/v1",
-    "api_key": "unused-proxy-attaches-real-creds"
-  }
-}
-```
-
-Then start your proxy in a terminal alongside `openviking-server`:
-
-```bash
-# Terminal 1
-hermes proxy start
-
-# Terminal 2
-openviking-server
-```
-
-OpenViking's VLM calls now flow through your Portal subscription. The
-embedding model side still needs its own provider — Portal does serve
-`/v1/embeddings` but the model selection depends on what your tier
-supports; check `portal.nousresearch.com/models`.
-
-## Configuring Karakeep (or any bookmark/summarizer app)
-
-[Karakeep](https://karakeep.app/) takes an OpenAI-compatible API for
-bookmark summarization. In its config:
-
-```bash
-# Karakeep .env
-OPENAI_API_BASE_URL=http://127.0.0.1:8645/v1
-OPENAI_API_KEY=any-non-empty-string
-INFERENCE_TEXT_MODEL=Hermes-4-70B
-```
-
-Same pattern works for Open WebUI, LobeChat, NextChat, or any other
-OpenAI-compatible client.
-
-## Exposing on LAN
-
-By default the proxy binds `127.0.0.1` (localhost only). To let other
-machines on your network use it:
-
-```bash
-hermes proxy start --host 0.0.0.0 --port 8645
-```
-
-⚠ **Be aware:** anyone on your network can now use your Portal
-subscription. The proxy has no auth of its own — it accepts any bearer.
-Use a firewall, VPN, or reverse proxy with proper auth if you expose
-this beyond your trusted network.
-
-## Rate limits
-
-Your Portal tier's RPM/TPM limits apply across the whole proxy. The
-proxy doesn't fan out or pool — it's a single bearer with your full
-subscription quota. Monitor usage at
-[portal.nousresearch.com](https://portal.nousresearch.com).
-
-## Architecture
-
-The proxy is intentionally minimal. Per request:
-
-1. Receive `POST /v1/chat/completions` from your app
-2. Look up the adapter's current credential (refresh if expiring)
-3. Forward the request body verbatim, with `Authorization: Bearer <minted-key>`
-4. Stream the response back unchanged (SSE preserved)
-
-No transformation. No logging of request bodies. No agent loop. The
-proxy is a credential-attaching pass-through.
-
-## Future: more OAuth providers
-
-The adapter system is pluggable. Adding a new provider (e.g.
-HuggingFace, GitHub Copilot's chat endpoint, Anthropic via OAuth)
-requires implementing `UpstreamAdapter` in
-`hermes_cli/proxy/adapters/<provider>.py` and registering it in
-`adapters/__init__.py`. Providers that aren't OpenAI-compatible at the
-protocol level (Anthropic Messages API, for example) would need a
-transformation layer, which is out of scope for the current shape.

package/docs/80_upstream-docs-and-skills/hermes-dev-skill/src/docs/user-guide/features/tool-gateway.md

@@ -1,223 +0,0 @@
----
-title: "Nous Tool Gateway"
-description: "One subscription, every tool. Web search, image generation, TTS, and cloud browsers — all routed through Nous Portal with no extra API keys."
-sidebar_label: "Tool Gateway"
-sidebar_position: 2
----
-
-# Nous Tool Gateway
-
-**One subscription. Every tool built in.**
-
-The Tool Gateway is included with every paid [Nous Portal](https://portal.nousresearch.com) subscription. It routes Hermes' tool calls — web search, image generation, text-to-speech, and cloud browser automation — through infrastructure Nous already runs, so you don't have to sign up with Firecrawl, FAL, OpenAI, Browser Use, or anyone else just to make your agent useful.
-
-<div style={{display: 'flex', gap: '1rem', flexWrap: 'wrap', margin: '1.5rem 0'}}>
-  <a href="https://portal.nousresearch.com/manage-subscription" style={{background: 'var(--ifm-color-primary)', color: 'white', padding: '0.75rem 1.5rem', borderRadius: '6px', textDecoration: 'none', fontWeight: 'bold'}}>Start or manage subscription →</a>
-</div>
-
-## What's included
-
-| | Tool | What you get |
-|---|---|---|
-| 🔍 | **Web search & extract** | Agent-grade web search and full-page extraction via Firecrawl. No rate limits to worry about — the gateway handles scaling. |
-| 🎨 | **Image generation** | Nine models under one endpoint: **FLUX 2 Klein 9B**, **FLUX 2 Pro**, **Z-Image Turbo**, **Nano Banana Pro** (Gemini 3 Pro Image), **GPT Image 1.5**, **GPT Image 2**, **Ideogram V3**, **Recraft V4 Pro**, **Qwen Image**. Pick per-generation with a flag, or let Hermes default to FLUX 2 Klein. |
-| 🔊 | **Text-to-speech** | OpenAI TTS voices wired into the `text_to_speech` tool. Drop voice notes into Telegram, generate audio for pipelines, narrate anything. |
-| 🌐 | **Cloud browser automation** | Headless Chromium sessions via Browser Use. `browser_navigate`, `browser_click`, `browser_type`, `browser_vision` — all the agent-driving primitives, no Browserbase account required. |
-
-All four are pay-as-you-use billed against your Nous subscription. Use any combination — run the gateway for web and images while keeping your own ElevenLabs key for TTS, or route everything through Nous.
-
-## Why it's here
-
-Building an agent that can actually *do things* means stitching together 5+ API subscriptions — each with their own signup, rate limits, billing, and quirks. The gateway collapses that into one account:
-
-- **One bill.** Pay Nous; we handle the rest.
-- **One signup.** No Firecrawl, FAL, Browser Use, or OpenAI audio accounts to manage.
-- **One key.** Your Nous Portal OAuth covers every tool.
-- **Same quality.** Same backends the direct-key route uses — just fronted by us.
-
-Bring your own keys anytime — per-tool, whenever you want to. The gateway isn't a lock-in, it's a shortcut.
-
-## Get started
-
-There are three ways in — pick whichever fits where you are:
-
-```bash
-hermes setup --portal     # Fresh install: Nous OAuth + set Nous as provider + turn on the Tool Gateway in one go
-```
-
-```bash
-hermes model              # Switch your inference provider to Nous Portal — Hermes then offers to turn on the gateway for all tools
-```
-
-```bash
-hermes tools              # Enable the gateway per-tool — pick "Nous Subscription" for any tool you want
-```
-
-`hermes setup --portal` and `hermes model` are the all-at-once paths: log in once, optionally flip every tool to the gateway. `hermes tools` is the à la carte path — turn on just the tools you want, one at a time.
-
-**You don't have to log in first.** With `hermes tools`, the Nous-managed backends (Web search, Image, Video, TTS, Browser) are always listed, even if you've never signed into Nous Portal. Select one and Hermes runs the Portal login right there if you aren't already authenticated — no need to run `hermes model` beforehand. If your Nous OAuth is already active, selecting the backend enables it immediately with no extra prompt. This path only logs you in and turns on the one tool you picked — it does **not** switch your inference provider, and it does **not** prompt you to enable the gateway for every other tool.
-
-Check what's active at any time:
-
-```bash
-hermes portal info        # 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)
-```
-
-`hermes portal info` shows a section like:
-
-```
-◆ Nous Tool Gateway
-  Nous Portal     ✓ managed tools available
-  Web tools       ✓ active via Nous subscription
-  Image gen       ✓ active via Nous subscription
-  TTS             ✓ active via Nous subscription
-  Browser         ○ active via Browser Use key
-```
-
-Tools marked "active via Nous subscription" are going through the gateway. Anything else is using your own keys.
-
-## Eligibility
-
-The Tool Gateway is a **paid-subscription** feature. [Upgrade your plan](https://portal.nousresearch.com/manage-subscription) to unlock the gateway.
-
-Some accounts are also entitled to a **free tool pool** — a small managed-tool allowance that covers gateway tool calls without a paid subscription. When a free pool is available, the gateway surfaces it and shows a setup prompt on first use, so you can opt in and start using managed tools right away.
-
-## The enablement checklist
-
-Picking a Nous model (`hermes model`) offers a per-tool checklist of gateway backends. Its behavior respects your existing setup:
-
-- Tools you've explicitly pointed at another backend (e.g. `web.backend: searxng`, `browser.cloud_provider: camofox`) are **never offered** — your selection can't be accidentally overwritten.
-- Tools configured via environment variables alone (e.g. `SEARXNG_URL`, `CAMOFOX_URL`) are offered **unchecked**, labeled to keep your own backend.
-- Only genuinely unconfigured tools come pre-checked.
-- Declines stick: if you submit the checklist with a tool unchecked, it won't be pre-checked on future Nous model swaps (stored in `tool_gateway_declined_tools` in `config.yaml`; checking it later clears the decline).
-
-## Mix and match
-
-The gateway is per-tool. Turn it on for just what you want:
-
-- **All tools through Nous** — easiest; one subscription, done.
-- **Gateway for web + images, bring your own TTS** — keep your ElevenLabs voice, let Nous handle the rest.
-- **Gateway only for things you don't have keys for** — "I already pay for Browserbase, but I don't want a Firecrawl account" works fine.
-
-Switch any tool at any time via:
-
-```bash
-hermes tools          # Interactive picker for each tool category
-```
-
-Select the tool, pick **Nous Subscription** as the provider (or any direct provider you prefer). No config editing required. If you aren't logged into Nous Portal yet, picking **Nous Subscription** kicks off the Portal login inline — you don't need to authenticate through `hermes model` first.
-
-## Using individual image models
-
-Image generation defaults to FLUX 2 Klein 9B for speed. Override per-call by passing the model ID to the `image_generate` tool:
-
-| Model | ID | Best for |
-|---|---|---|
-| FLUX 2 Klein 9B | `fal-ai/flux-2/klein/9b` | Fast, good default |
-| FLUX 2 Pro | `fal-ai/flux-2-pro` | Higher fidelity FLUX |
-| Z-Image Turbo | `fal-ai/z-image/turbo` | Stylized, fast |
-| Nano Banana Pro | `fal-ai/nano-banana-pro` | Google Gemini 3 Pro Image |
-| GPT Image 1.5 | `fal-ai/gpt-image-1.5` | OpenAI image gen, text+image |
-| GPT Image 2 | `fal-ai/gpt-image-2` | OpenAI latest |
-| Ideogram V3 | `fal-ai/ideogram/v3` | Strong prompt adherence + typography |
-| Recraft V4 Pro | `fal-ai/recraft/v4/pro/text-to-image` | Vector-style, graphic design |
-| Qwen Image | `fal-ai/qwen-image` | Alibaba multimodal |
-
-The set evolves — `hermes tools` → Image Generation shows the current live list.
-
----
-
-## Configuration reference
-
-Most users never need to touch this — `hermes model` and `hermes tools` cover every workflow interactively. This section is for writing config.yaml directly or scripting setups.
-
-### One selection key per tool category
-
-Each tool category has a single provider-selection key, written by the `hermes tools` picker (or the desktop GUI). Picking the **Nous Subscription** row stores the value `nous`, which routes that category through the managed Tool Gateway. Picking a BYOK row stores the vendor name (`fal`, `openai`, `firecrawl`, `browser-use`, ...), which goes direct with your own credentials:
-
-```yaml
-web:
-  backend: nous          # web search/extract via the Tool Gateway
-
-image_gen:
-  provider: nous         # image generation via the Tool Gateway
-
-tts:
-  provider: nous         # TTS via the Tool Gateway
-
-stt:
-  provider: nous         # speech-to-text via the Tool Gateway
-
-browser:
-  cloud_provider: nous   # cloud browser via the Tool Gateway
-```
-
-The runtime **always uses the stored selection** — credential presence never selects or reroutes a category. A `FAL_KEY` sitting in `.env` is ignored while `image_gen.provider: nous`; conversely, `image_gen.provider: fal` with no `FAL_KEY` set produces a clear error instead of silently falling back to the gateway:
-
-```
-image_gen is configured to use fal (set via hermes tools), but FAL_KEY is not set. Run 'hermes tools' to change it.
-```
-
-Categories you have **never configured** (no selection key ever written) autodetect from available credentials, same as before. But once a selection exists, adding a key to `.env` does not change the route — only `hermes tools` (or editing the selection key) does.
-
-### Switching back to your own keys
-
-```bash
-hermes tools    # pick the tool → choose a direct provider (e.g. Firecrawl)
-```
-
-Or set the selection key directly:
-
-```yaml
-web:
-  backend: firecrawl   # Hermes now uses FIRECRAWL_API_KEY from .env
-```
-
-### Legacy `use_gateway` flag (deprecated)
-
-Older Hermes versions used a per-tool `use_gateway: true` boolean to route through the gateway. That flag is **legacy**: it is never written anymore, and the `hermes tools` picker removes it from a category's config when it rewrites the selection. Old configs that still contain `use_gateway: true` are interpreted at read time as the `nous` selection, so existing setups keep working. Don't set `use_gateway` in new configs — select the provider in `hermes tools` instead.
-
-### Self-hosted gateway (advanced)
-
-Running your own Nous-compatible gateway? Override endpoints in `~/.hermes/.env`:
-
-```bash
-TOOL_GATEWAY_DOMAIN=your-domain.example.com
-TOOL_GATEWAY_SCHEME=https
-TOOL_GATEWAY_USER_TOKEN=your-token        # normally auto-populated from Portal login
-FIRECRAWL_GATEWAY_URL=https://...         # override one endpoint specifically
-TOOL_GATEWAY_URL=http://127.0.0.1:3009    # pin the shared managed origin exactly
-CONNECTOR_GATEWAY_URL=http://127.0.0.1:3009 # pin the connectors origin exactly
-```
-
-Every host is named `{label}-gateway.<domain>`, and `TOOL_GATEWAY_DOMAIN` / `TOOL_GATEWAY_SCHEME` reshape **all** of them; a `{LABEL}_GATEWAY_URL` pins one host exactly and skips the derivation:
-
-- `{vendor}-gateway.<domain>` — per-vendor passthroughs (Firecrawl, BFL, ...).
-- `tool-gateway.<domain>` — the shared managed origin: the vendors hosted on the gateway itself plus media uploads.
-- `connector-gateway.<domain>` — the connectors API (`/v1/connectors/*`), its own deployment. See [Tool Search → Connectors](./tool-search.md#connectors-remote-tools).
-
-These knobs exist for custom infrastructure setups (enterprise deployments, dev environments). Regular subscribers never set them.
-
-## FAQ
-
-### Does it work with Telegram / Discord / the other messaging gateways?
-
-Yes. Tool Gateway operates at the tool-execution layer, not the CLI. Every interface that can call a tool — CLI, Telegram, Discord, Slack, IRC, Teams, the API server, anything — benefits from it transparently.
-
-### What happens if my subscription expires?
-
-Tools routed through the gateway stop working until you renew or swap in direct API keys via `hermes tools`. Hermes shows a clear error pointing at the portal.
-
-### Can I see usage or costs per tool?
-
-Yes — the [Nous Portal dashboard](https://portal.nousresearch.com) breaks usage down by tool so you can see what's driving your bill.
-
-### Is Modal (serverless terminal) included?
-
-Modal is available as an **optional add-on** through the Nous subscription, not part of the default Tool Gateway bundle. Configure it via `hermes setup terminal` or directly in `config.yaml` when you want a remote sandbox for shell execution.
-
-### Do I need to delete my existing API keys when I enable the gateway?
-
-No — keep them in `.env`. While a tool's selection is **Nous Subscription**, direct keys for that tool are simply ignored. Pick the direct provider again in `hermes tools` and your keys become the source again. The gateway isn't a lock-in.