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
npx @guidekit/cli init

init scaffolds proxy-mode routes (/api/guidekit/token, /api/guidekit/llm, /api/guidekit/health), a provider component, and .env.local placeholders. Add GUIDEKIT_SECRET and LLM_API_KEY, then wrap your layout:


// app/layout.tsx
import { Providers } from './providers';
 
export default function Layout({ children }) {
  return (
    <html lang="en">
      <body>
        <Providers>{children}</Providers>
      </body>
    </html>
  );
}

GuideKit auto-discovers your site, builds a page model, and provides an AI assistant ready to help users. See Getting Started for the full proxy setup.

Packages

Package	Version	Audience	What it is	Status
`@guidekit/core`	`1.0.0`	Every integration	DOM scanner, orchestration, voice pipeline, visual guidance primitives	Core
`@guidekit/react`	`1.0.0`	React / Next.js apps	Provider, hooks, Shadow DOM widget	Core
`@guidekit/server`	`1.0.0`	Backend token endpoints	JWT token generation and session helpers	Core
`@guidekit/vanilla`	`1.0.0`	Non-React apps	IIFE bundle and framework-agnostic browser integration	Stable optional
`@guidekit/cli`	`1.0.0`	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`	`1.0.0`	Advanced guide reasoning	Semantic page intelligence engine	Advanced optional
`@guidekit/knowledge`	`1.0.0`	Retrieval-augmented guidance	Knowledge search and indexing utilities	Advanced optional
`@guidekit/plugins`	`1.0.0`	Extension authors	Plugin system and extension hooks	Advanced optional

Tier A packages (core, react, server, vanilla) ship together on breaking changes. Tier B optional packages require @guidekit/core@^1.0.0.

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.

Source

Browse the monorepo on GitHub .