Artisan-Style CLI Reference
FasORM ships with a command-line interface inspired by Laravel's Artisan tool. Scaffolding models, running database migrations, and executing seeders is simple and fast.
Command Summary Table
| Command | Description |
|---|---|
fasorm init |
Initialize FasORM directory structure, .env, and config file. |
fasorm make:model <Name> [-m] [-s] [-a] |
Generate model. Options: -m (migration), -s (Pydantic schema), -a (all: model, migration, schema, seeder). |
fasorm make:schema <Name> |
Generate a Pydantic v2 schema file in app/schemas/. |
fasorm make:migration <name> |
Generate a timestamped database migration file. |
fasorm make:seeder <Name> |
Generate a database seeder file in app/seeders/. |
fasorm migrate |
Run all pending database migrations against the configured database. |
fasorm migrate:rollback |
Roll back the last batch of database migrations. |
fasorm migrate:fresh |
Drop all tables and re-run all migrations from scratch. |
fasorm migrate:status |
Display a formatted table of applied and pending migrations. |
fasorm db:seed |
Execute database seeders to populate initial test data. |
Detailed Command Usage
Generating Code & Scaffolding
Terminal
# Create model only
fasorm make:model User
# Create model AND matching table migration
fasorm make:model Post -m
# Create model AND Pydantic schema
fasorm make:model Product -s
# Create standalone Pydantic schema in app/schemas/
fasorm make:schema Order
# Create ALL: Model + Migration + Schema + Seeder in one command!
fasorm make:model Category -a
Running & Rolling Back Migrations
Terminal
# Check migration status
fasorm migrate:status
# Apply pending migrations
fasorm migrate
# Rollback last migration batch
fasorm migrate:rollback