Skip to content

commands.md

Latest commit

 

History

History
132 lines (92 loc) · 2.43 KB

commands.md

File metadata and controls

132 lines (92 loc) · 2.43 KB
Raw

CLI Commands

Overview of all dext CLI commands.

Available Commands

Command Description
help Show all commands
migrate:up Run pending migrations
migrate:down Rollback last migration
migrate:list List migration status
migrate:generate Generate new migration
test Run test suite
scaffold Generate entities from DB
ui Start web dashboard
config:init Initialize configuration
env:scan Scan for Delphi environments
facade Generate Facade Unit

Migration Commands

migrate:up

Run all pending migrations:

dext migrate:up

migrate:down

Rollback the last applied migration:

dext migrate:down

migrate:list

Show migration status:

dext migrate:list

Output:

Migration Status
================
[✓] 001_CreateUsers       Applied: 2026-01-05 10:30:00
[✓] 002_AddEmailToUsers   Applied: 2026-01-06 14:15:00
[ ] 003_CreateOrders      Pending

migrate:generate

Create a new migration class:

dext migrate:generate --name CreateProducts

Test Commands

Basic test run

dext test

With code coverage

dext test --coverage

Generate HTML report

dext test --html --output TestReport.html

All options

dext test --coverage --html --xml --json --output ./reports/

Scaffold Command

Generate entities from database:

dext scaffold -c "mydb.db" -d sqlite -o Entities.pas

Options:

  • -c, --connection - Connection string
  • -d, --driver - Database driver (sqlite, pg, mssql, firebird)
  • -o, --output - Output file
  • --fluent - Use fluent mapping
  • -t, --tables - Specific tables (comma-separated)

Facade Command

Generate a "Facade Unit" (wildcard unit) that re-exports types and constants from a set of source units. This simplifies the uses clause for end-users.

dext facade -p Sources\Data -t Sources\Data\Dext.Entity.pas -x Dext.Entity

Options:

  • -p, --path - Source directory to scan for Pascal units.
  • -t, --target - Target output file (Pas file).
  • -x, --target-unit - The name of the target unit (e.g., Dext.Entity).
  • --verbose - Enable verbose logging.

Dashboard

Start the web monitoring UI:

dext ui
dext ui --port 8080

Visit http://localhost:3000 (or specified port).

← CLI | Next: Migrations →