FlowFast Documentation
Learn how to build full-stack applications 10x faster with our AI-powered development platform. From installation to production deployment.
Step 1: Get Your Credentials
- •Subscribe to any pricing plan
- •Check your email for welcome message
- •Look for email from Sasha from FlowFast
- •Save your email and secure access code
Step 2: Login to CLI
flowfast login- •Run
flowfast login - •Enter your email address
- •Enter your secure access code
- •You'll be automatically logged in
The same email you used for purchase
Format: FL0W-4CC3SS-XXXXXXXX
Prerequisites
Set up your environment with the required Node.js version before installing FlowFast
Install nvm (Node Version Manager)
First, install nvm to manage Node.js versions
Windows (Chocolatey):
choco install nvmLinux (apt):
sudo apt update && sudo apt install nvmsource ~/.bashrc (Linux) or reopen your terminal (Windows)Install Node.js v22.11.0
Install and use the required Node.js version
nvm install 22.11.0 && nvm use 22.11.0Verify Installation
Confirm Node.js version is correct
node --version🚨 Auto-Pilot Managed Folders
These folders are completely managed by Auto-Pilot and will be emptied on each code generation:
/app/managed
Never add your custom code to these folders within your project - they will be deleted during code generation!
⚠️ Compose Command Overwrites
flowfast compose command overwrites files in your project root. Always backup custom changes before running compose.
✅ Safe Development Practice
- • Keep custom code outside managed folders
- • Use version control (git) to track changes
- • Backup custom modifications before compose
- • Use Node.js v22.11.0 for compatibility
- • Get your access code from pricing page first
5-Minute Quick Start
Get from zero to production-ready application in just a few commands
Install CLI
Install FlowFast globally on your machine
npm i -g @flowfast/cliCreate Account & Get Credentials
Subscribe to a plan and receive your login credentials via email
Login to CLI
Authenticate with your email and access code
flowfast loginInitialize Project
Create a new project or use existing folder
flowfast initCompose Modules
Merge boilerplate code into your project
flowfast composeInstall Dependencies
Get your project ready for development
npm installStart Building
Launch the interactive FlowFast interface
flowfastCore Features Explained
Understand how each feature accelerates your development workflow
- Natural language to PostgreSQL schemas
- Iterative refinement through conversation
- Instant schema generation with proper constraints
- PostgreSQL-optimized data types and relationships
- Real-time ERD visualization
- Relationship mapping
- Design validation
- Export capabilities
- Starter: ORM schema generation
- Standard: Push schema + seed data
- Pro: tRPC APIs, Zod and Next.js app
- ⚠️ Manages /lib/trpc/managed and /app/managed folders
- Word-style undo/redo
- Recover from hallucinations
- Iterative refinement
- State management
CLI Command Reference
Complete reference of all FlowFast CLI commands
You must have a valid subscription and access code to use this command. Get your credentials from the pricing page.
Authenticate with your FlowFast account using the email and access code from your welcome email.
$ flowfast loginInitialize a new FlowFast project. Creates the project structure and configuration files.
If the app name already exists on our servers, we'll automatically load your saved state while setting up the local project structure. You get a fresh local setup that continues right where you left off.
$ flowfast init my-saas-app
$ flowfast init (prompts for app name)This command overwrites files in your project root. Always backup custom changes before running compose.
Merge module code into your project root. Handles file conflicts intelligently:
- • JSON files are merged
- • Environment files are concatenated
- • Other files are copied/overwritten
$ flowfast composeAuto-Pilot empties these folders from your project root during every code generation:
/app/managed
Launch the interactive FlowFast interface. This is where you'll do most of your work.
$ flowfastTeam Management Commands
Manage your team members and control access to your FlowFast workspace
List all team members in your subscription with their roles and status.
Display all current team members, their roles, and subscription status. Only available to subscription owners and admins.
$ flowfast subscribersExample Output:
Assign a seat to a team member. They'll receive an email with their access code.
Invite a new team member to your subscription. This uses one of your available seats and sends them a welcome email with their credentials.
$ flowfast invite teammate@company.comImmediately revokes access and frees up the seat for another team member.
Remove a team member from your subscription. This frees up their seat so you can invite someone else.
$ flowfast revoke former-teammate@company.comGive a team member admin access to manage users and settings.
Promote a team member to admin. Admins can invite/revoke users and manage team settings.
$ flowfast promote senior-dev@company.comRemove admin access from a team member while keeping them in the subscription.
Demote an admin back to regular user. They keep their seat but lose the ability to manage team members.
$ flowfast demote former-admin@company.comReady to Start Building?
You now have everything you need to start building production applications with FlowFast.