CLI Overview - Framefox

The Framefox CLI provides a comprehensive set of commands to manage your application development workflow. All commands follow the pattern framefox [namespace:]command [options].

Command Categories

Framefox CLI commands are organized into logical namespaces:

Main Commands

Core commands for project setup and development:

init - Initialize a new Framefox project
run - Start the development server

Create Commands

Generate application components:

create:controller - Create a new controller
create:entity - Create a new entity
create:crud - Generate CRUD controller for an entity

Database Commands

Manage your database and migrations:

database:create - Create the database
database:create-migration - Generate a migration file
database:upgrade - Apply pending migrations
database:downgrade - Revert migrations
database:status - Check migration status
database:drop - Drop the database
database:diagram - Generate database diagram
database:clear-migration - Clear migration files

Debug Commands

Development and debugging tools:

debug:router - Display all registered routes
debug:service - Display service container information
debug:config - Show configuration values

Cache Commands

Manage application cache:

cache:clear - Clear all caches
cache:warmup - Pre-warm the cache

Command Syntax

All Framefox commands follow a consistent syntax:

framefox [namespace:]command [arguments] [options]

Examples

# Main commands
framefox init
framefox run --port 8080

# Namespaced commands
framefox create:controller user
framefox database:upgrade
framefox cache:clear

Global Options

Most commands support the following options:

-h, --help - Display help information
-v, --verbose - Enable verbose output

Getting Help

To see all available commands:

framefox

To get help for a specific command:

framefox [command] --help

Command Output

The CLI uses colored output to make information easier to read:

Green - Success messages
Orange - Information and highlights
Yellow - Warnings
Red - Errors
Cyan - Values and data

Next Steps

Initialize Project

Create a new Framefox project

Run Server

Start the development server

Create Components

Generate controllers and entities

Manage Database

Work with migrations

Commands

​Command Categories

​Main Commands

​Create Commands

​Database Commands

​Debug Commands

​Cache Commands

​Command Syntax

​Examples

​Global Options

​Getting Help

​Command Output

​Next Steps