CLI Quick Start

The CLI requires a license key

Every purchase of VibeFast ships with GitHub repo access plus a license key for the CLI. The key unlocks vf init, vf add, vf remove, and the rest of the workflow. Always keep it secret and never commit it to your repo.

vf login --token YOUR_LICENSE_KEY

You only need to authenticate once per machine. The CLI stores the key securely and uses it for every command that touches the starter kit.

Install the CLI

npm install -g vibefast-cli

The CLI runs on macOS, Windows, and Linux and understands both sides of the monorepo (Expo/native + Next.js + Convex).

vf init: Clean or Custom

Run vf init in an empty directory. The CLI will:

1. Clone the vibefast repo.
2. Prompt you for a project name.
3. Ask whether you want Clean (minimal) or Custom (pick integrations now).
4. Let you choose the platforms: Native, Web, or Both.
5. Install dependencies with pnpm and wire up the environment.+
6. Save your license key for future commands.

Clean mode

Clean mode only installs the base necessities—auth, onboarding, and shared UI—so you start with a lean project you can build up with vf add later. Platforms are limited to the ones you select, so you can keep just mobile or just web if that’s all you need.

Custom mode

Custom mode lets you select every feature you want during initialization. The CLI installs the matching React Native, Next.js, and Convex pieces for each choice so you end up with a deployable starter that matches your current roadmap.

Add or remove integrations

Once you have a project, the CLI keeps everything manageable:

• vf add <feature> brings in the frontend routes, backend functions, and config required for a feature (chatbot, image generator, voice bot, tracker app, payments, quick actions, charts, etc.).
• vf remove <feature> rolls a feature back cleanly.
• vf list shows the integrations currently installed.

You can run vf add/vf remove regardless of whether you started with Clean or Custom mode. That makes the CLI ideal for adding one integration today and removing it tomorrow without touching dozens of files.

Sample flow

vf login --token YOUR_LICENSE_KEY
vf init
# Choose Custom, select chatbot + payments + tracker-app, choose Both (Native + Web)
cd my-vibefast-app
pnpm dev:native

Later, if you want to remove the tracker feature:

vf remove tracker-app

Every feature you add or remove keeps both the native and web clients in sync.