@guidekit/cli

CLI tools for the GuideKit SDK. Scaffolds projects, diagnoses configuration issues, and generates signing secrets.

Installation

npm install -g @guidekit/cli

Or use directly with npx:

npx @guidekit/cli <command>

Commands

guidekit init

Scaffolds GuideKit into your project. Detects your framework (Next.js App Router, Pages Router, or generic React) and generates:

• lib/guidekit-routes.ts plus /api/guidekit/{token,llm,health} routes (Next.js App Router)
• Provider component with tokenEndpoint, proxy, and llm model config
• .env.local template with required keys

npx guidekit init
npx guidekit init --platform   # also scaffolds STT/TTS routes and Platform Mode props
npx guidekit init --yes        # non-interactive defaults
npx guidekit init --json       # machine-readable output

guidekit doctor

Checks your environment for common issues:

• Required environment variables are set
• Packages are installed at compatible versions
• Proxy route files and provider wiring (Next.js App Router)
• Local /api/guidekit/token and /api/guidekit/health when the dev server is running
• External provider API reachability (Google AI, Deepgram, ElevenLabs)

npx guidekit doctor
npx guidekit doctor --fix      # apply safe fixes automatically
npx guidekit doctor --json     # machine-readable output

guidekit generate-secret

Generates a cryptographically secure signing secret for token generation.

npx guidekit generate-secret
npx guidekit generate-secret --write-env   # write GUIDEKIT_SECRET to .env.local
npx guidekit generate-secret --copy        # copy the secret to the clipboard
npx guidekit generate-secret --json        # machine-readable output

Or run npx guidekit on its own to open an interactive menu.

Documentation

• Full documentation: guidekit-docs.vercel.app/docs/cli
• Main README

License

MIT