Skip to main content

CLI Command Reference

This page is a quick command index. For guides, start with:

Global patterns​

  • The CLI reads ormed.yaml (auto-discovered, or use --config).
  • Use --connection <name> to select a connection block.
  • Many commands support --database to override the driver database option.

Commands​

init​

Scaffolds ormed.yaml plus migration/seeder registries:

dart run ormed_cli:ormed init

make​

Generates migrations or seeders:

dart run ormed_cli:ormed make --name create_users_table
dart run ormed_cli:ormed make --name create_users_table --format sql
dart run ormed_cli:ormed make --name UserSeeder --seeder

migrate​

Applies pending migrations:

dart run ormed_cli:ormed migrate
dart run ormed_cli:ormed migrate --limit 5
dart run ormed_cli:ormed migrate --pretend

migrate:export​

Exports up.sql and down.sql for migrations:

dart run ormed_cli:ormed migrate:export --out database/migration_sql
dart run ormed_cli:ormed migrate:export --out database/migration_sql --all

migrate:status​

dart run ormed_cli:ormed migrate:status
dart run ormed_cli:ormed migrate:status --pending

migrate:rollback​

dart run ormed_cli:ormed migrate:rollback
dart run ormed_cli:ormed migrate:rollback --steps 3

migrate:fresh / migrate:reset / migrate:refresh​

dart run ormed_cli:ormed migrate:fresh
dart run ormed_cli:ormed migrate:reset
dart run ormed_cli:ormed migrate:refresh

seed​

dart run ormed_cli:ormed seed
dart run ormed_cli:ormed seed --class UserSeeder
dart run ormed_cli:ormed seed --pretend

schema:dump​

dart run ormed_cli:ormed schema:dump
dart run ormed_cli:ormed schema:dump --prune

schema:describe​

dart run ormed_cli:ormed schema:describe
dart run ormed_cli:ormed schema:describe --json

db:wipe​

dart run ormed_cli:ormed db:wipe
dart run ormed_cli:ormed db:wipe --drop-views