Daraveldartisan
dartisan is Daravel's artisan. Install it once, then use it in any
project:
dart pub global activate dartisan_cli
dartisan new blog # or --template=minimal
cd blog && dartisan migrate --seed && dartisan serve --watch
Inside a project the global dartisan runs the project's own CLI,
bin/dartisan.dart, which knows your application and your own commands
(bootstrap/commands.dart). dartisan <command> --help lists a command's
options.
Project#
| Command | What it does |
|---|---|
about |
Versions, environment, drivers and paths |
doctor [--production] |
Checks configuration, database, storage and the port |
key:generate [--show] [--force] |
Writes a new APP_KEY |
env:encrypt, env:decrypt, env:obfuscate |
Encrypted .env files, see Configuration |
adopt <laravel-path> [--check] |
Shares the database and keys of a Laravel app, see Migrating from Laravel |
down [--secret] [--retry], up |
Maintenance mode, see Deployment |
stub:publish |
Copies the generator templates into stubs/ |
lint [--json] |
daravel_lints rules and registry checks |
Serve, test and build#
| Command | What it does |
|---|---|
serve [--watch] [--isolates=N] [--embed-queue] [--embed-scheduler] |
HTTP server; --watch hot-reloads |
test [--conformance] [--security] [--coverage] |
Runs the tests |
build [--with-cli] [--docker] |
Native bundle in build/server/bundle, optional Dockerfile |
route:list |
The route table |
openapi:generate [--output] |
OpenAPI 3.1 from the routes and their declared metadata |
Database#
| Command | What it does |
|---|---|
migrate [--seed], migrate:status, migrate:rollback, migrate:reset |
Migrations |
migrate:fresh [--seed] [--force] |
Drops every table and migrates again (refused in production without --force) |
db:seed [--class] |
Runs seeders |
db:show, db:table <table> [--limit] |
Tables, columns and rows |
tinker "<expression>" |
Evaluates a Dart expression in the booted application |
model:sync [Model] |
Regenerates a model's typed accessors from its table |
Queues and scheduling#
| Command | What it does |
|---|---|
queue:work [--queue] [--tries] [--max-time] [--stop-when-empty] |
Processes jobs; stops after the current job on SIGTERM |
queue:failed, queue:retry, queue:forget, queue:flush |
Failed jobs |
queue:clear, queue:pause, queue:continue, queue:restart |
Queue control |
schedule:work, schedule:run, schedule:list |
The scheduler |
cache:clear, storage:link, coordinator:stats |
Cache, public storage link, coordinator state |
Generators#
make:model [-m -f -s -c -p -r --api --all], make:migration,
make:seeder, make:factory, make:controller [--api --resource --model],
make:request, make:middleware, make:job, make:policy, make:event,
make:listener, make:resource, make:rule, make:observer,
make:provider, make:command and make:test. Each one writes the file
from a template and adds it to the matching registry in bootstrap/.
Your own commands#
final class SendReports extends DaravelCommand {
SendReports(super.createApp);
@override
String get name => 'reports:send';
@override
String get description => 'Email the weekly reports.';
@override
Future<int> run() => withApp((app) async {
// The application is booted; facades work here.
return 0;
});
}
dartisan make:command SendReports writes this and registers it in
bootstrap/commands.dart.