For the complete documentation index, see llms.txt. Markdown variants are available by appending .md to any URL or sending an Accept: text/markdown header. An agent skill is available at /.well-known/agent-skills/site-skill.md.
102
Sponsor

Installation

PreviousNext

Install an agent recipe into your Eve or Flue project.

Prerequisites

Complete these before running the install command.

1. An agent project. Start from an existing one or scaffold a new project:

  • Eve — npx eve@latest init my-agent (docs). Recipes install under agent/, which Eve discovers automatically.
  • Flue — npx flue@latest init my-agent (docs). Recipes install under agents/, workflows/, tools/, and skills/.

2. The framework package. Each recipe declares its framework package (eve or @flue/runtime) as a dependency, so the shadcn CLI prompts to install it if it is missing.

3. Environment variables. Some recipes call external services and need secrets set in your project's environment — for example EXA_API_KEY for web search, WORKSPACE_DIR for the sandboxed assistant, or a database URL for the SQL recipe. The required keys are documented in each recipe's tools and instructions; add them to your .env before invoking the agent.

4. Live preview (optional). To run a recipe's preview from this docs site, set ANTHROPIC_API_KEY. The Eve preview can additionally proxy a deployed Eve instance via EVE_PREVIEW_URL — see the Preview Backend notes.

Add a Recipe

From your project root, run the install command shown on the recipe's page. For example, the Deep Search agent:

Eve

# Eve
npx shadcn@latest add @agentcn/eve/deep-search

Flue

$ pnpm dlx shadcn@latest add @agentcn/flue/deep-search

The CLI writes the recipe's files into your project at their target paths — for Eve, under agent/; for Flue, under agents/, workflows/, tools/, and skills/. Your framework discovers them automatically.

Prefer short names like @agentcn/eve/deep-search? Register the namespace once — see Registry.

Customize

The installed files are plain source — you own them. Common changes:

  • Swap the model in the agent definition.
  • Extend the tools by adding files alongside the installed ones.
  • Reshape the output schema to capture the fields you care about.

See each recipe's Customization section for specifics.

Usage

Start your project's dev server (for example pnpm dev) and invoke the agent through your framework — Eve exposes it through a durable session, Flue through its route handler. You can also try any recipe before installing it using the live preview embedded in its docs page.