What's included in VibeFast?

VibeFast bundles a React Native + Expo app, Next.js landing page, Convex backend, AI features, payments, auth, localization, and a component library so you can launch day one.

Do I need React Native experience?

Experience helps but isn't required. The codebase is structured for AI pair programming and clear customization, so beginners and pros can ship fast.

Can I customize the design and features?

Yes. Everything is modular—UI, logic, and integrations—so you can tailor the product to your brand and use case.

CLI Command Reference

Complete reference documentation for the VibeFast CLI (vf). All commands support --help for detailed information.

Global Options

These options work with all commands:

-V, --version    # Show CLI version
-h, --help       # Show help for command

Commands Overview

Command	Description
`vf login`	Authenticate with your license key
`vf logout`	Clear stored authentication
`vf devices`	Manage device activations
`vf list`	List available features
`vf add`	Add features to your project
`vf remove`	Remove installed features
`vf status`	Show installed features
`vf checklist`	View manual setup steps
`vf env`	Interactive environment setup
`vf doctor`	Check your VibeFast setup
`vf health`	Check project health

Initialization Commands

`vf init`

Interactive project creation that lets you start with mobile, web, or both.

Usage:

vf init

Setup mode

vf init walks you through:

Choosing between Clean (minimal essentials) and Custom (pick only the integrations you need)
Selecting platforms: Native (Expo), Web (Next.js), or Both
Naming your project and entering your license key so the CLI can configure Convex, routes, and assets

Clean mode gives you a lean starter and is perfect for mobile-only or web-only cases. Custom mode installs exactly what you choose so nothing extra lands in your repo. After initialization you can still run vf add to bring in new integrations or vf remove to prune them—both commands understand which platforms each feature targets.

What happens next?

The chosen platform scaffolds (Expo, Next.js, or both) are configured.
Selected features and integrations are downloaded, their files merged, and dependencies installed.
Required assets (Vosk, AI recipes, etc.) are fetched automatically.
Environment files and your Convex backend are wired up so you can start developing immediately.

Keep refining the workspace with vf add / vf remove instead of manually editing the repo.

Authentication Commands

Authenticate with the VibeFast license key you received when you purchased the starter kit. You need to log in once before using other CLI commands.

Usage:

vf login --token YOUR_LICENSE_KEY

Options:

--token <token> - Your VibeFast license key (required)

Example:

vf login --token vf_1234567890abcdef

Output:

✓ Successfully authenticated
✓ Device registered: MacBook Pro (9160c34d)

`vf logout`

Clear your stored authentication token.

Usage:

vf logout

Example:

vf logout

Output:

✓ Logged out successfully

`vf devices`

Manage your device activations.

Usage:

vf devices [options]

Options:

--deactivate <device-id> - Deactivate a specific device

Examples:

# List all activated devices
vf devices

# Deactivate a device
vf devices --deactivate 9160c34d

Output:

Your Devices:
  1. MacBook Pro (9160c34d) - Active
  2. iMac (a1b2c3d4) - Active
  3. Windows PC (e5f6g7h8) - Active

Device limit: 3/5

Feature Management Commands

`vf list`

List all available features organized by category.

Usage:

vf list

Example:

vf list

Output:

📱 Native (Expo) Features
  • audio-recorder - Record and manage voice notes
  • charts - Beautiful data visualization with charts
  • chatbot - AI-powered chat assistant
  • image-analysis - AI-powered image analysis with trait detection
  • image-generator - AI-powered image generation
  • ios-widget - iOS Home Screen widgets with Live Activities
  • quiz - Interactive quiz feature
  • tracker-app - Simple calorie tracker with a clean UI
  • voice-bot - Real-time voice conversations with AI
  • wake-word - Wake word detection with Vosk

Commands:
  vf add <feature>       Install a feature
  vf checklist <feature> View setup steps
  vf status              Show installed features

`vf add`

Add features, UI components, or integrations to your project.

Usage:

vf add [feature] [options]

Options:

--target <target> - Target platform: native or web (default: auto-detect)
--dry-run - Preview changes without applying
--force - Overwrite existing files without asking
--yes - Answer yes to all prompts (for automation)

Examples:

# Interactive mode (recommended)
vf add

# Install specific feature
vf add chatbot

# Preview without installing
vf add chatbot --dry-run

# Force reinstall
vf add chatbot --force

# Automated installation (no prompts)
vf add chatbot --yes

Interactive Mode:

┌  🎯 VibeFast Feature Installer
│
◆  Select features to add:
│  ◻ audio-recorder
│  ◻ charts
│  ◻ chatbot
│  ◻ image-analysis
│  ◼ image-generator  ← selected
│  ◻ ios-widget
│  ◻ quiz
│  ◻ tracker-app
│  ◻ voice-bot
│  ◻ wake-word
└  

  

◇  Fetching image-generator...
◇  ✓ Recipe fetched
◇  Downloading and extracting recipe...
◇  ✓ Recipe downloaded

ℹ Installing image-generator v1.0.0...
✓ image-generator installed successfully!
ℹ Files added: 15

⚠ REQUIRED ENVIRONMENT VARIABLES:
  REPLICATE_API_TOKEN
    Get your API token from Replicate
    Example: r8_...
    Get it: https://replicate.com/account/api-tokens

ℹ Add these to your .env file

└  ✨ Installation complete!

What the CLI Does:

Fetches the feature recipe from the server
Downloads and extracts files
Copies files to your project
Adds navigation links (if applicable)
Installs dependencies (with confirmation)
Downloads assets (like Vosk models)
Shows manual setup steps
Detects missing environment variables

`vf remove`

Remove an installed feature from your project.

Usage:

vf remove <feature> [options]

Options:

--target <target> - Target platform: native or web
--dry-run - Preview what will be removed
--yes - Skip confirmation prompts

Examples:

# Remove a feature
vf remove chatbot

# Preview removal
vf remove chatbot --dry-run

# Remove without confirmation
vf remove chatbot --yes

Output:

⚠ This will remove:
  • 25 files
  • Navigation entry
  • Dependencies (if not used by other features)

Are you sure? (y/n): y

✓ Removed chatbot successfully
ℹ Run 'pnpm install' to clean up unused dependencies

`vf status`

Show all installed features and their status.

Usage:

vf status

Example:

vf status

Output:

Installed Features:

✓ chatbot
  Files: 25
  Installed: 2 hours ago
  
✓ image-generator
  Files: 15
  Installed: 1 hour ago
  
✓ wake-word
  Files: 12
  Installed: 30 minutes ago

Total: 3 features installed

`vf checklist`

View manual setup steps for a feature.

Usage:

vf checklist <feature> [options]

Options:

--target <target> - Target platform: native or web

Examples:

# View checklist for a feature
vf checklist chatbot

Output:

📋 Manual Setup Steps for chatbot

⚠ REQUIRED ENVIRONMENT VARIABLES:

  OPENAI_API_KEY
    Your OpenAI API key for chat functionality
    Example: sk-...
    Get it: https://platform.openai.com/api-keys

⚠ MANUAL STEPS REQUIRED:

  Step 1: Configure AI Provider
    Update the AI provider settings in your backend
    File: packages/backend/convex/lib/ai/config.ts
    Add: export const AI_PROVIDER = 'openai';

  Step 2: Enable Streaming
    Enable streaming responses in your app config
    File: apps/native/app.config.ts
    Add: streaming: { enabled: true }

💡 Run 'vf env' for interactive environment setup

Environment & Setup Commands

`vf env`

Interactive environment variable setup.

Usage:

vf env [options]

Options:

--dry-run - Preview what would be configured

Example:

vf env

Interactive Flow:

🔍 Checking environment variables...

Missing variables for installed features:
  • OPENAI_API_KEY (needed by: chatbot, image-generator)
  • REPLICATE_API_TOKEN (needed by: image-generator)

Would you like to set them up now? (y/n): y

◆  Enter OPENAI_API_KEY:
│  sk-...
└  

◆  Enter REPLICATE_API_TOKEN:
│  r8_...
└  

✓ Environment variables saved to .env
✓ Run 'pnpm dev' to apply changes

`vf doctor`

Check your VibeFast setup and configuration.

Usage:

vf doctor

Example:

vf doctor

Output:

ℹ Checking authentication...
✓ Authenticated

ℹ Checking repository signature...
✓ Valid VibeFast repository
  Name: vibefast
  Version: 1.0.0

ℹ Checking navigation markers...
✓ Native nav file found
✓ Web nav file found

ℹ Checking installed features...
✓ 4 features installed
✓ All features valid

✓ Setup complete

`vf health`

Check project health and configuration.

Usage:

vf health

Example:

vf health

Output:

Project Health Check:

✓ Dependencies installed
✓ TypeScript configuration valid
✓ Environment variables configured
⚠ Some features need manual setup
  Run: vf checklist chatbot

✓ Overall health: Good

Advanced Usage

Combining Commands

# Install multiple features in sequence
vf add chatbot && vf add image-generator && vf add wake-word

# Install and check status
vf add chatbot && vf status

# Install and view checklist
vf add chatbot && vf checklist chatbot

Using in Scripts

#!/bin/bash
# setup-features.sh

# Install features non-interactively
vf add chatbot --yes
vf add image-generator --yes --target native
vf add wake-word --yes

# Check status
vf status

# Show what needs manual setup
vf checklist chatbot
vf checklist image-generator
vf checklist wake-word

CI/CD Integration

# .github/workflows/test-features.yml
name: Test Features

on: [push]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      
      - name: Install CLI
        run: npm install -g vibefast-cli
      
      - name: Authenticate
        run: vf login --token ${{ secrets.VIBEFAST_TOKEN }}
      
      - name: Install features
        run: |
          vf add chatbot --yes
          vf add image-generator --yes
      
      - name: Check status
        run: vf status
      
      - name: Run tests
        run: pnpm test

Exit Codes

The CLI uses standard exit codes:

0 - Success
1 - General error
2 - Invalid arguments
3 - Authentication error
4 - Network error
5 - File system error

Example:

vf add chatbot
echo $?  # Prints exit code

Environment Variables

The CLI respects these environment variables:

# Skip interactive prompts
CI=true vf add chatbot

# Custom config directory
VIBEFAST_CONFIG_DIR=~/.config/vibefast vf login

# Verbose output
DEBUG=vf:* vf add chatbot

Tips & Tricks

1. Use Tab Completion

Enable tab completion for faster command entry:

# For bash
vf completion bash >> ~/.bashrc

# For zsh
vf completion zsh >> ~/.zshrc

2. Alias Common Commands

# Add to ~/.bashrc or ~/.zshrc
alias vfa='vf add'
alias vfs='vf status'
alias vfl='vf list'

3. Check Before Installing

# Always check what's available first
vf list

# Preview before installing
vf add chatbot --dry-run

# Check requirements
vf checklist chatbot

4. Keep CLI Updated

# Check current version
vf --version

# Update to latest
npm update -g vibefast-cli

Getting Help

Command Help

# General help
vf --help

# Command-specific help
vf add --help
vf remove --help
vf env --help

Support

📧 Email: support@vibefast.pro
💬 Discord: Join our community
📚 Docs: vibefast.pro/docs
🐛 Issues: GitHub Issues

Next Steps

CLI Quick Start - Get started with the CLI
Feature Customization - Learn about each feature
Environment Setup - Configure environment variables

CLI Command Reference

Global Options

Commands Overview

Initialization Commands

`vf init`

Setup mode

What happens next?

Authentication Commands

`vf logout`

`vf devices`

Feature Management Commands

`vf list`

`vf add`

`vf remove`

`vf status`

`vf checklist`

Environment & Setup Commands

`vf env`

`vf doctor`

`vf health`

Advanced Usage

Combining Commands

Using in Scripts

CI/CD Integration

Exit Codes

Environment Variables

Tips & Tricks

1. Use Tab Completion

2. Alias Common Commands

3. Check Before Installing

4. Keep CLI Updated

Getting Help

Command Help

Support

Next Steps

Found an issue or bug in the docs?

On this page