Getting Started

Installation

Install Surf packages

Surf lets any website expose typed commands for AI agents. Install the packages you need and start building in minutes.

Installation#

Three packages โ€” pick what you need:

Server-side โ€” expose commands

bash
npm install @surfjs/core

Agent/client-side โ€” discover & execute

bash
npm install @surfjs/client

DevUI โ€” interactive inspector (optional)

bash
npm install @surfjs/devui

CLI โ€” inspect & test from terminal (optional)

bash
npm install -g @surfjs/cli

Next.js adapter (optional)

bash
npm install @surfjs/next

Zod schema integration (optional)

bash
npm install @surfjs/zod

React hooks for Surf Live (optional)

bash
npm install @surfjs/react