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/coreAgent/client-side โ discover & execute
bash
npm install @surfjs/clientDevUI โ interactive inspector (optional)
bash
npm install @surfjs/devuiCLI โ inspect & test from terminal (optional)
bash
npm install -g @surfjs/cliNext.js adapter (optional)
bash
npm install @surfjs/nextZod schema integration (optional)
bash
npm install @surfjs/zodReact hooks for Surf Live (optional)
bash
npm install @surfjs/react