Skip to content

armgit / eve

Public Imported from GitHub
0

The Open Framework for Building Agents

docs: document registry installation (#1156)

Colton Padden6e0224d73106
diff --git a/apps/docs/lib/integrations/connection-setup.test.ts b/apps/docs/lib/integrations/connection-setup.test.ts
index f1d2a4bbb..2e534e4c2 100644
--- a/apps/docs/lib/integrations/connection-setup.test.ts
+++ b/apps/docs/lib/integrations/connection-setup.test.ts
@@ -34,7 +34,7 @@ describe("Kernel extension setup", () => {
const integration = getIntegration("kernel")!;
expect(integration.type).toBe("extension");
- expect(integration.install).toContain("pnpm add @onkernel/eve-extension");
+ expect(integration.install).toContain("eve add extension/kernel");
expect(integration.quickStart).toContain(
'kernel({ connect: "mcp.onkernel.com/eve-extension" })',
);
diff --git a/apps/docs/lib/integrations/data.ts b/apps/docs/lib/integrations/data.ts
index 4647ebe04..4404e4e6c 100644
--- a/apps/docs/lib/integrations/data.ts
+++ b/apps/docs/lib/integrations/data.ts
@@ -1159,7 +1159,7 @@ const extensionPresentations: Record<string, ExtensionPresentation> = {
install: `Install the Browserbase extension for eve:
\`\`\`bash
-pnpm add @browserbasehq/eve
+eve add extension/browserbase
\`\`\`
The extension requires Node.js 24 or later. A Browserbase API key covers both cloud browser sessions and Stagehand inference through Browserbase Model Gateway, so you do not need a separate model-provider key.`,
@@ -1212,7 +1212,7 @@ Browserbase uses keep-alive sessions and eve's durable per-session state to reco
install: `Install the Kernel extension for eve:
\`\`\`bash
-pnpm add @onkernel/eve-extension
+eve add extension/kernel
\`\`\`
The extension requires Node.js 24 or later and eve 0.25 or later. It mounts Kernel's hosted MCP browser tools and a \`browse\` skill without requiring you to maintain browser tool code.`,
@@ -1318,7 +1318,7 @@ For multi-tenant agents, set \`userId\` to a stable tenant-scoped value or deriv
install: `Install the Jetty extension for eve:
\`\`\`bash
-pnpm add @jetty/eve
+eve add extension/jetty
\`\`\`
The extension requires Node.js 24 or later and eve 0.25 or later. It can ingest every completed turn as a durable Jetty trajectory, grade turns inline, steer experiments from their grades, and report native \`eve eval\` results.`,
@@ -1377,7 +1377,7 @@ Jetty trajectories persist agent inputs and outputs. Redact PII before grading,
install: `Install the GitHub Tools extension and Vercel Connect client:
\`\`\`bash
-pnpm add @github-tools/eve-extension @vercel/connect
+eve add extension/github-tools
\`\`\`
The extension provides the GitHub toolset as a versioned eve package. Use a Vercel Connect connector for short-lived, scoped GitHub tokens, or omit \`@vercel/connect\` and authenticate with a GitHub token.`,
@@ -1442,7 +1442,7 @@ For local or non-Vercel deployments, omit \`connector\` and set \`GITHUB_TOKEN\`
install: `Install the agent-browser extension for eve:
\`\`\`bash
-pnpm add @agent-browser/eve
+eve add extension/agent-browser
\`\`\`
The extension installs agent-browser automatically on first use and runs it inside the agent's sandbox. It requires a sandbox backend with real process execution, such as Vercel Sandbox, Docker, or microsandbox.`,
diff --git a/apps/docs/lib/integrations/discovery.test.ts b/apps/docs/lib/integrations/discovery.test.ts
index 712e2f810..9bf42a790 100644
--- a/apps/docs/lib/integrations/discovery.test.ts
+++ b/apps/docs/lib/integrations/discovery.test.ts
@@ -37,7 +37,7 @@ describe("integration discovery", () => {
expect(browserbase).toBeDefined();
const markdown = integrationMarkdown(browserbase!);
- expect(markdown).toContain("pnpm add @browserbasehq/eve");
+ expect(markdown).toContain("eve add extension/browserbase");
expect(markdown).toContain('import browserbase from "@browserbasehq/eve"');
expect(markdown).toContain("BROWSERBASE_API_KEY");
expect(integrationSearchText(browserbase!)).toContain("Stagehand");
@@ -48,7 +48,7 @@ describe("integration discovery", () => {
expect(jetty).toBeDefined();
const markdown = integrationMarkdown(jetty!);
- expect(markdown).toContain("pnpm add @jetty/eve");
+ expect(markdown).toContain("eve add extension/jetty");
expect(markdown).toContain('import jetty from "@jetty/eve"');
expect(markdown).toContain('import { Jetty } from "@jetty/eve/reporter"');
expect(markdown).toContain("JETTY_API_TOKEN");
@@ -73,7 +73,7 @@ describe("integration discovery", () => {
expect(githubTools).toBeDefined();
const markdown = integrationMarkdown(githubTools!);
- expect(markdown).toContain("pnpm add @github-tools/eve-extension");
+ expect(markdown).toContain("eve add extension/github-tools");
expect(markdown).toContain('connector: "github/my-connector"');
expect(markdown).toContain('preset: "maintainer"');
expect(markdown).toContain("github__addPullRequestComment");
diff --git a/docs/install-integrations.mdx b/docs/install-integrations.mdx
new file mode 100644
index 000000000..cb7108e80
--- /dev/null
+++ b/docs/install-integrations.mdx
@@ -0,0 +1,106 @@
+---
+title: "Install Integrations"
+description: "Discover and install extensions and other integrations from eve and third-party sources."
+contentType: "How-to"
+---
+
+Install integrations from eve's official catalog, a third-party source, or an integration URL. Integrations are distributed using the [shadcn registry format](https://ui.shadcn.com/docs/registry).
+
+## Install an integration
+
+Run `eve add` from an eve agent project. This installs the integration's dependencies and writes its declared files into your project.
+
+```bash
+eve add extension/agent-browser
+```
+
+The integration may create an extension mount under `agent/extensions/`. Configure that mount and any required environment variables before running your agent.
+
+## Find an integration
+
+Browse the [Integrations directory](/integrations) to see the official integrations available from the eve registry.
+
+List every official integration and configured third-party source:
+
+```bash
+eve registry list
+```
+
+Search the catalog when you know what capability you need:
+
+```bash
+eve registry search browser
+```
+
+Inspect an integration before you install it:
+
+```bash
+eve registry view extension/agent-browser
+```
+
+`list` and `search` include the official eve catalog and every source you add to the project.
+
+## Add a third-party source
+
+Give a registry a namespace and an integration URL template:
+
+```bash
+eve registry add @acme=https://registry.acme.com/r/{name}.json
+```
+
+eve stores the mapping in `package.json#registries`. The `{name}` placeholder becomes the integration name, so `@acme/analytics` resolves to `https://registry.acme.com/r/analytics.json`.
+
+Limit listing or search to that registry when needed:
+
+```bash
+eve registry list --registry @acme
+eve registry search analytics --registry @acme
+```
+
+Install an integration from that source:
+
+```bash
+eve add @acme/analytics
+```
+
+Install a known integration URL directly when you do not need a namespace:
+
+```bash
+eve add https://registry.acme.com/r/analytics.json
+```
+
+## Configure generated files
+
+Integrations add project files. Read the generated mount before you run the agent, then add the configuration the extension requires.
+
+For an extension, this usually means setting environment variables and editing the file under `agent/extensions/`. See [Extensions](./extensions) for mount configuration, namespacing, and overrides.
+
+Provider-specific setup lives in the [Integrations directory](/integrations). Follow that guidance for credentials, approval policies, and service-specific options.
+
+## Update an installed integration
+
+Treat generated files as project code. Commit or review local changes before you install the integration again.
+
+Run the same command when the registry publisher provides an updated scaffold:
+
+```bash
+eve add extension/agent-browser
+```
+
+Pass `--overwrite` only when you intend to replace an existing generated file:
+
+```bash
+eve add extension/agent-browser --overwrite
+```
+
+Update the installed package with your package manager. Check the publisher's release notes before changing the generated mount or package version.
+
+## Choose trusted sources
+
+Integrations can add dependencies and write files. Add sources you trust, inspect an integration with `eve registry view`, and review the resulting project diff before you run the agent.
+
+## What to read next
+
+- [Extensions](./extensions): configure and override installed extension mounts
+- [Integrations directory](/integrations): provider-specific setup and security guidance
+- [shadcn registry documentation](https://ui.shadcn.com/docs/registry): publish a compatible third-party registry
diff --git a/docs/meta.json b/docs/meta.json
index 1a5385750..91ce3852c 100644
--- a/docs/meta.json
+++ b/docs/meta.json
@@ -4,6 +4,7 @@
"getting-started",
"installation",
"project-structure",
+ "install-integrations",
"---Build Your Agent---",
"agent-config",
"instructions",