Getting Started
Add the ARCY AI agent to your web app in about 15 minutes.
The ARCY SDK (@arcyai/sdk) is a JavaScript package that embeds an AI agent directly inside your existing web application. Once installed, your users get three AI-powered capabilities: a contextual Chat assistant that answers product questions in real time, a Teach mode that coaches users through any workflow by highlighting UI elements step by step, and an Agent mode that navigates pages, clicks buttons, and fills forms autonomously on the user's behalf.
Setup has three parts: install ARCYProvider in your app, add data-arcy attributes to your interactive elements so the AI can reference them, and push a .arcy/ knowledge graph that tells the AI what your product does. Run arcy init and the CLI handles all three automatically.
SDK
Quickstart
Add ARCY to your app in about 15 minutes.
CLI Commands
arcy init, sync, push, pull, validate, status, log, and rm.
Configuration
All ARCYProvider props.
data-arcy Attributes
Annotate interactive elements so Chat, Teach, and Agent modes can reference them.
AI Modes
How Chat, Teach, and Agent modes work and when to use each.
Customization
Configure branding, modes, usage limits, and UI controls from the dashboard or via code.
useArcy Hook
Access session-level values from the SDK runtime.