@guideflow/cli
v0.1.9
Published
CLI for GuideFlow.js — init, studio, export, and push flows
Downloads
93
Maintainers
Readme
@guideflow/cli
CLI for GuideFlow — scaffold, build, export, and publish product tours.
Command-line tool for GuideFlow. Scaffold configurations, launch the visual tour editor, export flow definitions, and publish to GuideFlow Cloud.
Installation
# Global install
npm install -g @guideflow/cli
# Or use via npx
npx @guideflow/cli initCommands
| Command | Description |
|---------|-------------|
| guideflow init | Scaffold a guideflow.config.ts and example flow in your project |
| guideflow studio | Launch the visual tour editor in your browser |
| guideflow export | Export flow definitions to JSON files |
| guideflow push | Publish flows to GuideFlow Cloud |
Usage
Initialize a Project
guideflow initPrompts you to select a framework (React, Vue, Svelte, or vanilla JS) and creates a starter configuration with an example tour flow.
Visual Tour Editor
guideflow studioOpens a local development server with the visual tour builder where you can create and edit tours interactively.
Export Flows
guideflow exportExports all flow definitions to JSON format, suitable for version control or deployment.
Push to Cloud
guideflow pushPublishes your flow definitions to GuideFlow Cloud for remote management.
Related Packages
@guideflow/core— Core engine@guideflow/react— React adapter@guideflow/vue— Vue 3 adapter@guideflow/svelte— Svelte adapter
