CLI Tools

The @guidekit/cli package provides command-line tools for project setup and diagnostics.

Installation

The CLI is available via npx (no installation needed):


npx guidekit <command>

Or install globally:


npm install -g @guidekit/cli

Commands

`guidekit init`

Interactive setup wizard that scaffolds GuideKit configuration for your project.


npx guidekit init

What it does:

Detects your framework (Next.js App Router, Pages Router, React)
Checks for missing packages
Creates .env.local with GuideKit variables
Creates a token endpoint (for token-based auth)
Creates a provider wrapper component (Next.js App Router)

`guidekit doctor`

Validates your setup — checks environment variables, packages, provider connectivity, and, when run inside the GuideKit monorepo, CI/local parity for the example app and release-confidence workflows.


npx guidekit doctor

Checks performed:

.env / .env.local file exists
.gitignore includes .env files
GUIDEKIT_SECRET is set and valid length
LLM_API_KEY is present
STT_API_KEY and TTS_API_KEY (optional, for voice)
@guidekit/core, @guidekit/react, @guidekit/server are installed
Connectivity to Google AI, Deepgram, and ElevenLabs APIs
In the GuideKit monorepo, example-app token-route parity, hosted PR E2E coverage, and the Nightly dependency-audit gate

Example output:


GuideKit Doctor — Checking your setup

ℹ Project root: /Users/you/myapp

Environment
✓ .env file: Found .env.local
✓ .gitignore: .env files are ignored
✓ GUIDEKIT_SECRET: Set and valid length
✓ LLM API Key: Found
○ STT API Key: Not set (optional)
○ TTS API Key: Not set (optional)

Packages
✓ @guidekit/core: Installed (^0.1.0)
✓ @guidekit/react: Installed (^0.1.0)
✓ @guidekit/server: Installed (^0.1.0)

Connectivity
✓ LLM provider connectivity: Reachable
✓ STT provider connectivity: Reachable
✓ TTS provider connectivity: Reachable

✓ All checks passed! Your GuideKit setup looks good.

`guidekit generate-secret`

Generates a cryptographically random 256-bit signing secret for JWT token authentication.


npx guidekit generate-secret

Output:


GuideKit — Generate Signing Secret

✓ Generated a cryptographically random 256-bit signing secret:

  SIIwq8fzeBsh1s5WTTMBZEiXcxU5BH51A0ScD5ORVvQ

Add this to your .env file:

  GUIDEKIT_SECRET=SIIwq8fzeBsh1s5WTTMBZEiXcxU5BH51A0ScD5ORVvQ

Warning: Keep this secret safe. Never commit it to version control.

Help


npx guidekit --help
npx guidekit --version