Merge branch 'main' into docs-chat-cloud-first

docs(nemoclaw): add Cloud API URL to quickstart and config default (#1700 )
* docs(nemoclaw): prioritize Hindsight Cloud with callout banners * feat(nemoclaw): default --api-url to Hindsight Cloud, make it optional
2026-05-22 09:53:48 -04:00 · 2026-05-22 09:52:58 -04:00 · 2026-05-22 09:37:02 -04:00 · 2026-05-22 09:36:15 -04:00 · 2026-05-21 14:36:48 -04:00
11 changed files with 47 additions and 31 deletions
@@ -10,6 +10,12 @@ We built `@vectorize-io/hindsight-chat` to give [Vercel Chat SDK](https://github

 [View Changelog →](/changelog/integrations/chat)

+## Setup
+
+:::tip Hindsight Cloud (recommended)
+[Sign up free](https://ui.hindsight.vectorize.io/signup) — get an API key instantly, no infrastructure to run. Self-hosting? See the [installation guide](/developer/installation).
+:::
+
 ## Installation

 ```bash
@@ -28,6 +28,10 @@ After install, the **Hindsight** plugin appears under **Tools** in the workflow

 ## Setup

+:::tip Recommended: Hindsight Cloud
+[Sign up free](https://ui.hindsight.vectorize.io/signup) and grab an API key — no self-hosting required.
+:::
+
 1. **Sign up** at [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) (free tier) or [self-host](/developer/installation)
 2. **Get an API key** from the Hindsight dashboard
 3. **In Dify**, open the Hindsight plugin and add credentials:
@@ -14,16 +14,17 @@ NemoClaw runs [OpenClaw](https://openclaw.ai) inside an OpenShell sandbox with c

 ## Quick Start

+:::tip Hindsight Cloud (recommended)
+[Sign up free](https://ui.hindsight.vectorize.io/signup) — get an API key instantly, no infrastructure to run.
+:::
+
 ```bash
 npx @vectorize-io/hindsight-nemoclaw setup \
  --sandbox my-assistant \
-  --api-url https://api.hindsight.vectorize.io \
  --api-token <your-api-key> \
  --bank-prefix my-sandbox
 ```

-Get an API key at [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup).
-
 You'll see output like:

 ```
@@ -79,8 +80,8 @@ hindsight-nemoclaw setup [options]

 Options:
  --sandbox <name>       NemoClaw sandbox name (required)
-  --api-url <url>        Hindsight API URL (required)
  --api-token <token>    Hindsight API token (required)
+  --api-url <url>        Hindsight API URL (default: https://api.hindsight.vectorize.io)
  --bank-prefix <prefix> Memory bank prefix (default: "nemoclaw")
  --skip-policy          Skip sandbox network policy update
  --skip-plugin-install  Skip openclaw plugin installation
@@ -20,17 +20,18 @@ Then configure in **Settings → Plugins → Hindsight Memory**.

 ## Prerequisites

-Either:
+:::tip Hindsight Cloud (recommended)
+[Sign up free](https://ui.hindsight.vectorize.io/signup) — no infrastructure to run. Skip straight to Configuration below.
+:::
+
+**Self-hosting alternative** — run Hindsight locally:

 ```bash
-# Self-hosted
 pip install hindsight-all
 export HINDSIGHT_API_LLM_API_KEY=your-openai-key
 hindsight-api
 ```

-Or [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) — no self-hosting required.
-
 ## How It Works

 ```
@@ -58,7 +59,7 @@ Memory is keyed to `companyId` + `agentId` — never to the run ID — so it acc

 | Field | Default | Description |
 |-------|---------|-------------|
-| `hindsightApiUrl` | `http://localhost:8888` | Hindsight server URL |
+| `hindsightApiUrl` | `https://api.hindsight.vectorize.io` | Hindsight server URL (Cloud default; use `http://localhost:8888` for self-hosted) |
 | `hindsightApiKeyRef` | — | Paperclip secret name holding Hindsight Cloud API key |
 | `bankGranularity` | `["company", "agent"]` | Memory isolation: per company+agent, per company, or per agent |
 | `recallBudget` | `mid` | `low` = fastest, `mid` = balanced, `high` = most thorough |
@@ -31,7 +31,7 @@ This guide covers the quick-start path, the HTTP and process adapter patterns, b
 Before you start, make sure you have:

 - A Paperclip agent already running through the heartbeat model
- A reachable Hindsight backend, either self-hosted or [Hindsight Cloud](https://hindsight.vectorize.io)
+- A Hindsight backend: [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) (recommended — free tier, no infrastructure to run) or [self-hosted](https://hindsight.vectorize.io/developer/installation)
 - Stable identifiers for `companyId` and `agentId`

 The identifier design matters. Paperclip's default isolation pattern works well because it maps cleanly to a multi-tenant setup.
@@ -2,6 +2,12 @@

 Give your [Vercel Chat SDK](https://github.com/vercel/chat) bots persistent, per-user memory with a single handler wrapper. Works with Slack, Discord, Teams, Google Chat, GitHub, and Linear.

+## Setup
+
+> ✨ **Recommended:** [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) — sign up free, get an API key, and you're ready. No infrastructure to run.
+>
+> Self-hosting alternative: [installation guide](https://hindsight.vectorize.io/developer/installation).
+
 ## Quick Start

 ```bash
@@ -10,6 +10,8 @@ Three tools — **Retain**, **Recall**, **Reflect** — drop into any Dify workf

 ## Setup

+> ✨ **Recommended: [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup)** — free tier, no self-hosting required. Sign up and grab an API key in under a minute.
+
 1. **Sign up** at [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) (free tier) or [self-host](https://hindsight.vectorize.io/developer/installation).
 2. **Get an API key** from the Hindsight dashboard.
 3. **In Dify**, install this plugin (Marketplace or upload `.difypkg`), then add credentials:
@@ -6,16 +6,15 @@ NemoClaw runs [OpenClaw](https://openclaw.ai) inside an OpenShell sandbox with s

 ## Quick Start

+> ✨ **Recommended:** Use [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) — sign up free and get an API key instantly. No infrastructure to run.
+
 ```bash
 npx @vectorize-io/hindsight-nemoclaw setup \
  --sandbox my-assistant \
-  --api-url https://api.hindsight.vectorize.io \
  --api-token <your-api-key> \
  --bank-prefix my-sandbox
 ```

-Get an API key at [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup).
-
 ## Documentation

 Full setup guide, pitfalls, and troubleshooting:
@@ -31,8 +30,8 @@ hindsight-nemoclaw setup [options]

 Options:
  --sandbox <name>       NemoClaw sandbox name (required)
-  --api-url <url>        Hindsight API URL (required)
  --api-token <token>    Hindsight API token (required)
+  --api-url <url>        Hindsight API URL (default: https://api.hindsight.vectorize.io)
  --bank-prefix <prefix> Memory bank prefix (default: "nemoclaw")
  --skip-policy          Skip sandbox network policy update
  --skip-plugin-install  Skip openclaw plugin installation
@@ -10,11 +10,11 @@ Usage:

 Required options:
  --sandbox <name>       NemoClaw sandbox name (e.g. my-assistant)
-  --api-url <url>        Hindsight Cloud API URL (https://api.hindsight.vectorize.io)
  --api-token <token>    Hindsight API key from https://ui.hindsight.vectorize.io
  --bank-prefix <prefix> Bank ID prefix (memories go to <prefix>-openclaw)

 Optional options:
+  --api-url <url>        Hindsight API URL (default: https://api.hindsight.vectorize.io)
  --skip-policy          Skip the openshell policy update
  --skip-plugin-install  Skip openclaw plugins install
  --dry-run              Print what would be changed without executing
@@ -23,7 +23,6 @@ Optional options:
 Example:
  hindsight-nemoclaw setup \\
    --sandbox my-assistant \\
-    --api-url https://api.hindsight.vectorize.io \\
    --api-token hsk_abc123 \\
    --bank-prefix my-sandbox
 `);
@@ -49,13 +48,12 @@ function parseArgs(argv: string[]): CliArgs | null {
  };

  const sandbox = get("--sandbox");
-  const apiUrl = get("--api-url");
+  const apiUrl = get("--api-url") ?? "https://api.hindsight.vectorize.io";
  const apiToken = get("--api-token");
  const bankPrefix = get("--bank-prefix");

  const missing: string[] = [];
  if (!sandbox) missing.push("--sandbox");
-  if (!apiUrl) missing.push("--api-url");
  if (!apiToken) missing.push("--api-token");
  if (!bankPrefix) missing.push("--bank-prefix");

@@ -20,26 +20,25 @@ Then configure in **Settings → Plugins → Hindsight Memory**.

 ## Prerequisites

-Either:
+> ✨ **Recommended:** [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) — sign up free, get an API key, and skip the self-hosting setup entirely.
+
+**Self-hosting alternative** — run Hindsight locally:

 ```bash
-# Self-hosted (runs locally)
 pip install hindsight-all
 export HINDSIGHT_API_LLM_API_KEY=your-openai-key
 hindsight-api
 ```

-Or [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup) — no self-hosting required.
-
 ## Configuration

-| Field                | Default                 | Description                                                    |
-| -------------------- | ----------------------- | -------------------------------------------------------------- |
-| `hindsightApiUrl`    | `http://localhost:8888` | Hindsight server URL                                           |
-| `hindsightApiKeyRef` | —                       | Paperclip secret name holding Hindsight Cloud API key          |
-| `bankGranularity`    | `["company", "agent"]`  | Memory isolation: per company+agent, per company, or per agent |
-| `recallBudget`       | `mid`                   | `low` = fastest, `mid` = balanced, `high` = most thorough      |
-| `autoRetain`         | `true`                  | Automatically retain run output after every run                |
+| Field                | Default                              | Description                                                                       |
+| -------------------- | ------------------------------------ | --------------------------------------------------------------------------------- |
+| `hindsightApiUrl`    | `https://api.hindsight.vectorize.io` | Hindsight server URL (Cloud default; use `http://localhost:8888` for self-hosted) |
+| `hindsightApiKeyRef` | —                                    | Paperclip secret name holding Hindsight Cloud API key                             |
+| `bankGranularity`    | `["company", "agent"]`               | Memory isolation: per company+agent, per company, or per agent                    |
+| `recallBudget`       | `mid`                                | `low` = fastest, `mid` = balanced, `high` = most thorough                         |
+| `autoRetain`         | `true`                               | Automatically retain run output after every run                                   |

 ## Bank ID Format

@@ -31,8 +31,8 @@ const manifest: PaperclipPluginManifestV1 = {
        type: "string",
        title: "Hindsight API URL",
        description:
-          "Base URL of your Hindsight instance. Use http://localhost:8888 for self-hosted.",
-        default: "http://localhost:8888",
+          "Base URL of your Hindsight instance. Defaults to Hindsight Cloud. Use http://localhost:8888 for self-hosted.",
+        default: "https://api.hindsight.vectorize.io",
      },
      hindsightApiKeyRef: {
        type: "string",
Author	SHA1	Message	Date
Ben	73bbe5f736	Merge branch 'main' into docs-chat-cloud-first	2026-05-22 09:53:48 -04:00
Ben	806fbcd41c	docs(nemoclaw): add Cloud API URL to quickstart and config default (#1700 ) * docs(nemoclaw): prioritize Hindsight Cloud with callout banners * feat(nemoclaw): default --api-url to Hindsight Cloud, make it optional	2026-05-22 09:52:58 -04:00
Ben	a75c3c85ad	docs(paperclip): add Cloud API URL to quickstart and config default (#1699 ) * docs(paperclip): prioritize Hindsight Cloud in setup docs and config default * style(paperclip): align table columns after linter reformat	2026-05-22 09:37:02 -04:00
Ben	0db9f3da19	docs(dify): add Cloud Recommended callout (#1698 ) dify already led with Cloud signup — adds the explicit ✨ Recommended banner for visual consistency.	2026-05-22 09:36:15 -04:00
Ben	6bdb1a08f5	docs(chat): add Hindsight Cloud setup callout to README and docs	2026-05-21 14:36:48 -04:00