VibeFast CLI

Official CLI for installing VibeFast features into your monorepo.

✨ New in v0.2.0

• Interactive Confirmation - No more silent overwrites! CLI asks before replacing files
• Package Management - Shows required packages with npx expo install command
• Modification Detection - Warns before deleting files you've modified
• Manual Steps - Clear setup instructions for services like Sentry, PostHog
• New Commands - vf status and vf checklist for better management
• Better Errors - User-friendly error messages with actionable solutions

See full changelog

Installation

npm install -g vibefast-cli

Or use directly with npx:

npx vibefast-cli <command>

Quick Start

1. Login with your token: Use the same license key you received in your LemonSqueezy receipt:

vf login --token YOUR_LICENSE_KEY

2. Verify your setup:

vf doctor

3. List available features:

vf list

4. Install a feature:

vf add charts
vf add charts-web --target web

5. Check what's installed:

vf status

6. Remove a feature:

vf remove charts

Commands

vf login --token <TOKEN>

Authenticate with your VibeFast license token.

vf logout

Clear your stored token.

vf devices

List your active device activations.

Options:

• --deactivate <id> - Free up a device slot

vf doctor

Check your VibeFast setup and verify all requirements.

vf list

Show all available features for your license.

vf add <feature>

Install a feature into your project.

Options:

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

Example:

vf add charts --target native
vf add chatbot --target web --force
vf add sentry --yes  # For CI/CD

What happens:

1. Downloads and extracts the feature
2. Copies files to your project
3. Adds navigation link (if applicable)
4. Shows required packages to install
5. Shows manual setup steps (if needed)

vf remove <feature>

Remove an installed feature.

Options:

• --target <native|web> - Target platform (default: native)
• --dry-run - Preview changes without applying
• --force - Skip modification check
• --yes - Answer yes to all prompts

Example:

vf remove charts --target native

What happens:

1. Checks if files were modified (warns you)
2. Deletes all tracked files
3. Removes navigation link
4. Updates journal

vf status 🆕

Show all installed features and their status.

Example:

$ vf status

Installed features:

  ✓ charts (v1.0.0) - native
    Files: 17
    Installed: 11/13/2024

  ✓ sentry (v1.2.0) - native
    Files: 5
    Installed: 11/13/2024
    ⚠ Has manual setup steps

Total: 2 feature(s) installed

vf checklist <feature> 🆕

Show manual setup steps for an installed feature.

Options:

• --target <native|web> - Target platform (default: native)

Example:

vf checklist sentry

When to use: Some features (like Sentry, PostHog, Stripe) require external service setup. After installing such features, you'll see:

⚠ MANUAL STEPS REQUIRED:

Step 1: Create Sentry Account
  Sign up at sentry.io and create a project
  🔗 https://sentry.io/signup/

💡 Run 'vf checklist sentry' to see these steps again

Run vf checklist <feature> anytime to see the setup instructions again.

Requirements

• Node.js 18+
• A VibeFast monorepo with .vibefast/starter.json
• Valid VibeFast license token

Device Limits

Each license includes 2 device slots by default. A device is identified by a stable ID based on your machine's username, hostname, and OS. You can manage your devices with:

vf devices                    # List active devices
vf devices --deactivate <id>  # Free a slot

Troubleshooting

"Not a VibeFast repo"

• Make sure you're in the root of your VibeFast monorepo
• Check that .vibefast/starter.json exists

"Not logged in"

• Run vf login --token <YOUR_TOKEN>

"Device limit reached"

• Run vf devices to see active devices
• Deactivate unused devices with vf devices --deactivate <id>

"Missing navigation markers"

• Ensure your nav files have the required marker comments
• Run vf doctor to check

Environment Variables

• VIBEFAST_WORKER_URL - Override the API endpoint (default: https://api.vibefast.pro)

Documentation

• README.md - This file (user guide)
• CHANGELOG.md - Version history
• HOW-IT-WORKS.md - Technical architecture
• MANUAL-STEPS-GUIDE.md - Guide for recipe creators
• IMPLEMENTATION-COMPLETE.md - Implementation details

Support

For issues or questions, contact [email protected]