Packages
GuideFlow is published as a collection of scoped npm packages. Install only what you need.
Core
| Package | Description | Install |
|---|---|---|
| @guideflow/core | Tour engine, state machine, spotlight, renderer — zero runtime dependencies | npm i @guideflow/core |
Framework Adapters
| Package | Description | Install |
|---|---|---|
| @guideflow/react | React hooks & components (TourProvider, useTour, TourStep) | npm i @guideflow/react |
| @guideflow/vue | Vue 3 plugin & composables (GuideFlowPlugin, useTour) | npm i @guideflow/vue |
| @guideflow/svelte | Svelte store adapter (createTourStore) | npm i @guideflow/svelte |
AI & Analytics
| Package | Description | Install |
|---|---|---|
| @guideflow/ai | Auto-generate tours, intent detection, conversational help | npm i @guideflow/ai |
| @guideflow/analytics | Event tracking, transports (PostHog, Mixpanel, Amplitude), A/B testing | npm i @guideflow/analytics |
Tooling
| Package | Description | Install |
|---|---|---|
| @guideflow/cli | Scaffold flows, validate configs, export tours from the terminal | npm i -g @guideflow/cli |
| @guideflow/devtools | Chrome/Firefox extension — visual tour builder, flow inspector, AI assist | Install from source |
Version Matrix
All packages follow the same version number and are released together via Changesets.
| Current version | License |
|---|---|
| 0.1.4 | MIT |