Set up Vendo with your agent

Prompt

Install Vendo in this repo. Read https://vendo.run/agents.md and follow it exactly. Relay Vendo’s setup questions to me and use my answers. Ask me before creating any account or key — Vendo Cloud is the recommended option. You’re done when my app runs and the agent answers from my own API. Then ask me whether I’d like to star it via https://vendo.run/star?src=docs to support the project.

Your agent picks the right setup for your repo. You confirm it.

Just want an agent?

The smallest thing Vendo does needs no CLI, no init, and nothing moved around. Install one package and write one call:

import { agent } from "@vendoai/agents";

const support = agent({
  name: "support",
  instructions: "Answer in the product's voice; never invent account numbers.",
});

console.log((await support.chat("Where is order A-1001?")).text);

Give it tools, put it on a route, or hand it a schedule from there: backend quickstart. Everything below is the rest of Vendo — the embedded surface and the generated screens — and init is how you get there.

Quickstart

No agent handy? Do it by hand. Three steps.

Install

One package. Only the blocks your project uses ship.

npm install @vendoai/vendo

pnpm add @vendoai/vendo

On pnpm the install downloads everything and then exits 1 with Ignored build scripts: @mongodb-js/zstd, esbuild, node-liblzma. None of the three needs compiling — Vendo reaches esbuild through its Node API, which that script has nothing to do with, and the other two are the shell’s optional native tar backends, behind guarded imports nothing calls. pnpm writes the three names into your pnpm-workspace.yaml with a placeholder; set all three to false and install again.

pnpm-workspace.yaml

allowBuilds:
  '@mongodb-js/zstd': false
  esbuild: false
  node-liblzma: false

Run npx vendo init

init reads your repo before it asks anything. Then it writes the wiring.

terminal

$ npx vendo init

  Your stack
  Next.js · App Router · TypeScript · pnpm
  Clerk auth (@clerk/nextjs)

? How will people use your agent?
    Embedded in my app — chat + generated UI            recommended
    Through my own agent loop (AI SDK / Mastra)
    From outside agents over MCP (experimental)

  … init takes it from there: it asks how you want to run models,
    writes the wiring, and prints one snippet for you to paste.

Paste the snippet init prints. It comes with your real paths already filled in, and it is the only edit you make by hand.On Next.js it also adds one line to your next.config — serverExternalPackages: ["@vendoai/apps", "esbuild", "@electric-sql/pglite", "@vendoai/store"]. Vendo checks every generated screen with esbuild at runtime, so its checker has to stay out of the server bundle. If init could not read your config, it prints the line instead and vendo doctor holds you to it (E-CFG-004).

Continue in your direction

The init was the same for everyone. From here the code differs: the answer you gave that first question is the path you are on. Continue with the one you picked.

Vendo's Full-Stack Agent

Vendo runs the loop and renders screens in your brand.<VendoProvider>Quickstart →

In your existing agent

Keep your loop. Vendo adds tools and renders the result.vendoTools(vendo)Quickstart →

From outside agents

Your own agent, acting as the signed-in user.createVendo({ mcp: true })Quickstart →

Get started

In your backend

Install with your agent

Vendo's Full-Stack Agent

In your existing agent

From outside agents

Generated UI & apps

Make it yours

Capabilities

Production

Users & orgs

Set up Vendo with your agent

Just want an agent?

Quickstart

Vendo's Full-Stack Agent

In your existing agent

From outside agents

​Just want an agent?

​Quickstart

Vendo's Full-Stack Agent

In your existing agent

From outside agents

Just want an agent?

Quickstart