Skip to content

CLI Reference - Essential Commands

Here are the Framefox terminal commands you’ll actually use! No overwhelming lists - just the essentials that help you build cool stuff.

These 5 commands will handle 90% of what you need:

Terminal window
mkdir myproject
cd myproject
framefox init

Creates a complete new Framefox project with the proper project structure.

Terminal window
framefox run

Runs your app at http://localhost:8000 with auto-reload when you make changes.

Terminal window
framefox database create-migration
framefox database upgrade

Updates your database when you add/change entities.

Terminal window
framefox create controller
framefox create entity
framefox create crud

Creates controllers, entities, and complete CRUD systems.

Terminal window
framefox create user

Sets up authentication, login, signup - the whole user system!

Terminal window
# Create project directory
mkdir gamevault
cd gamevault
# Initialize Framefox project
framefox init
# Start the server
framefox run
8000/controllername
framefox create controller
# Follow prompts to name your controller
# Creates [controller](/framefox/core/controllers) + [template](/framefox/core/templates)
Terminal window
framefox create entity
# Follow the prompts to add fields
# Creates: [SQLModel entity](/framefox/core/database) and repository
Terminal window
framefox create crud
# Choose your entity, then "Templated CRUD controller"
# Creates: [forms](/framefox/core/forms), pages, everything!
Terminal window
framefox create user
# Creates complete [authentication system](/framefox/core/security)
# Login/signup pages included!
Terminal window
framefox database create
Terminal window
# After adding/changing [entities](/framefox/core/database)
framefox database create-migration
framefox database upgrade
Terminal window
framefox database status
Terminal window
framefox debug router
Terminal window
framefox cache clear
Terminal window
# 1. Create the data model
framefox create entity
# 2. Update database
framefox database create-migration
framefox database upgrade
# 3. Create the web interface
framefox create crud
# 4. Test it!
framefox run
Terminal window
# 1. Create project
mkdir myproject
cd myproject
framefox init
# 2. Set up database
framefox database create
# 3. Add user accounts
framefox create user
framefox database create-migration
framefox database upgrade
# 4. Run it!
framefox run
Terminal window
framefox cache clear
framefox run
Terminal window
framefox database status
# Check what went wrong
Terminal window
framefox debug router
# Lists all your URLs
Terminal window
framefox --help
framefox create --help
framefox database --help
  • Keep framefox run running in one terminal
  • Use another terminal for commands
  • The server auto-reloads when you change files!
  • Instead of building forms manually, use framefox create crud
  • It creates everything: forms, validation, pages, buttons
  • You can customize the generated code afterward
  • Always run migrations after changing entities
  • Check framefox database status if something seems off
  • Never edit migration files directly
  • Use framefox debug router to see all your pages
  • Check the terminal where framefox run is running for error messages
  • framefox cache clear fixes many weird issues

These commands will take you from zero to a working web application using Framefox’s interactive terminal. Don’t get overwhelmed by complex documentation - just start building and learn as you go!

Ready to build something awesome? Go back to the QuickLaunch guide and start creating! 🚀

Creates your database file (for SQLite) or connects to your database server.
### Create a migration
```bash
framefox database create-migration

After you change your models, this creates a “migration” file that updates your database structure.

Terminal window
framefox database upgrade

Actually applies the changes to your database. Run this after creating migrations.

Terminal window
framefox database status

Shows you what’s currently in your database and if there are pending changes.

These are the magic commands that save you tons of time!

Terminal window
framefox create controller name

Creates a controller (handles web requests) and its template file.

Terminal window
framefox create entity name

Creates a database model with interactive prompts for properties.

Terminal window
framefox create crud entity-name

Creates everything needed to add/edit/delete/view records: controller, forms, templates.

Terminal window
framefox create user

Sets up complete user authentication: registration, login, password security.

When things go wrong, these help you figure out what’s happening:

Terminal window
framefox debug router

Shows all the URLs your app responds to and which controllers handle them.

Terminal window
framefox cache clear

If weird things are happening, try this first. Clears all cached data.

Print this out and keep it handy!

What you want to doCommand
Start new projectframefox init project-name
Start development serverframefox run
Create databaseframefox database create
Add new modelframefox create entity name
Add web pages for modelframefox create crud name
Add user accountsframefox create user
Update databaseframefox database create-migration then framefox database upgrade
See all URLsframefox debug router
Fix weird issuesframefox cache clear
Terminal window
framefox init my-app
cd my-app
python -m venv venv
source venv/bin/activate # or venv\Scripts\activate on Windows
pip install -r requirements.txt
framefox database create
framefox run
Terminal window
# 1. Create the model
framefox create entity feature
# 2. Update database
framefox database create-migration
framefox database upgrade
# 3. Create web pages
framefox create crud feature
# 4. Test it!
framefox run
Terminal window
# Try these in order:
framefox cache clear
framefox database status
framefox debug router

Most terminals support tab completion. Type framefox cr and press Tab to see framefox create.

After running generation commands, look at the files created. You’ll learn a lot!

You don’t need to remember every command. Keep this page bookmarked and refer to it.

Use the basic commands first. As you get comfortable, explore the advanced options.

  • Full documentation: Check the main Framefox docs for detailed explanations
  • Interactive help: Add --help to any command for specific options
  • Community: Join the Framefox Discord or GitHub discussions

Remember: every developer looks up commands. Even experienced ones! Don’t feel bad about referring to this page often. 😊

These commands will get you through 90% of your Framefox development. As you build more complex apps, you’ll naturally discover additional commands and options.

The most important thing? Start building! Use these commands to create your first project and see what happens. That’s how you really learn.

Happy coding! 🎉