GuideKit
Embed an AI guide that truly understands your website
GuideKit is an embeddable React/Next.js SDK that gives your app an AI assistant capable of:
- Understanding your site’s structure, content, and navigation automatically
- Conversing via voice or text — answers questions, explains sections, guides users
- Visually guiding — spotlights elements, scrolls to sections, shows tooltips
- Navigating — routes users to different pages within your SPA
- Custom actions — add-to-cart, submit forms, or any developer-defined operation
Quick Start
npm install @guidekit/core @guidekit/react @guidekit/server// app/layout.tsx
import { GuideKitProvider } from '@guidekit/react';
export default function Layout({ children }) {
return (
<GuideKitProvider
tokenEndpoint="/api/guidekit/token"
agent={{ name: 'Guide', greeting: 'Hi! How can I help?' }}
>
{children}
</GuideKitProvider>
);
}That’s it. GuideKit auto-discovers your site, builds a page model, and provides an AI assistant ready to help users.
Packages
| Package | Version | Audience | What it is | Status |
|---|---|---|---|---|
@guidekit/core | 0.2.0 | Every integration | DOM scanner, orchestration, voice pipeline, visual guidance primitives | Core |
@guidekit/react | 0.2.0 | React / Next.js apps | Provider, hooks, Shadow DOM widget | Core |
@guidekit/server | 0.2.0 | Backend token endpoints | JWT token generation and session helpers | Core |
@guidekit/vanilla | 0.1.1 | Non-React apps | IIFE bundle and framework-agnostic browser integration | Stable optional |
@guidekit/cli | 0.1.1 | Local setup and contributors | CLI tools for init, doctor, secrets, and parity diagnostics | Optional DX |
@guidekit/vad | 0.1.1 | Voice experiences | Silero VAD model and helpers | Optional voice |
@guidekit/intelligence | 0.1.1 | Advanced guide reasoning | Semantic page intelligence engine | Advanced optional |
@guidekit/knowledge | 0.1.1 | Retrieval-augmented guidance | Knowledge search and indexing utilities | Advanced optional |
@guidekit/plugins | 0.1.1 | Extension authors | Plugin system and extension hooks | Advanced optional |
GuideKit packages release independently. The 0.2.0 track is the recommended default surface today, while 0.1.1 packages represent optional or advanced capabilities that are intentionally versioned on their own cadence.
Key Features
Text-First, Voice-Enhanced
The SDK works in text-only mode out of the box. Voice is an enhancement layer — no microphone required for core functionality.
Token-Based Security
API keys never reach the browser. The @guidekit/server package generates short-lived JWT tokens, and provider keys stay server-side.
DOM Intelligence
GuideKit’s TreeWalker-based scanner builds a compact PageModel that the LLM uses to understand page structure, sections, forms, and navigation — all without manual configuration.
Developer Extensibility
Register custom actions, provide content maps to prevent hallucination, set page context, and hook into every event via the typed EventBus.