Skip to main content
Aeros provides a powerful command-line interface (CLI) built on Symfony Console components. The CLI tool, called aeros, allows you to scaffold code, manage your database, run the application, and perform various development tasks.

The Aeros REPL

The REPL (Read-Eval-Print Loop) is the entry point for all CLI commands. It’s a PHP script located at the root of your Aeros project.

Starting the REPL

php aeros
This command displays all available commands and their descriptions.

Getting Help

Get detailed information about any command using the --help flag:
php aeros <command> --help
All Aeros CLI commands are powered by Symfony Console. Learn more in the Symfony Console documentation.

Available Command Categories

Aeros CLI commands are organized into several categories:

Make Commands

Scaffold controllers, models, migrations, and more

Database Commands

Manage migrations, seeders, and database setup

Cache Commands

Clear and manage cache connections

Run Commands

Start the application, workers, and cron scheduler

Command Structure

Aeros commands follow a consistent pattern:
php aeros <command:subcommand> [arguments] [options]

Arguments

Arguments are required or optional values passed to commands:
php aeros make:controller UserController

Options

Options modify command behavior and are prefixed with -- or -:
php aeros make:worker EmailWorker --all
php aeros run:app -p  # -p is short for --production

Run Commands

Commands for starting and managing your application:

run:app

Starts the application with environment setup, database checks, migrations, cache validation, and worker initialization.
php aeros run:app
Options:
  • -p, --production - Run in production environment
  • -s, --staging - Run in staging environment
  • -d, --development - Run in development environment (default)
The run:app command performs a complete application bootstrap including database connectivity checks, running migrations, warming up the cache, and starting workers.

scheduler

Runs all scheduled cron jobs. This command is typically called from the system crontab:
php aeros scheduler
Crontab Example:
* * * * * /usr/bin/php /var/www/html/aeros scheduler 1>> /var/www/html/app/logs/error.log 2>&1

run:worker

Starts queue workers to process background jobs:
php aeros run:worker [workers...] [options]
Arguments:
  • workers - Space-separated list of specific workers to run
Options:
  • -a, --all - Start all registered workers
  • --stop - Stop running workers
Examples:
# Start all workers
php aeros run:worker --all

# Start specific workers
php aeros run:worker EmailWorker NotificationWorker

# Stop workers
php aeros run:worker --stop

run:cron

Manually runs a specific cron job or all cron jobs:
php aeros run:cron [name] [options]
Arguments:
  • name - Optional name of a specific cron job to run
Options:
  • -a, --all - Run all scheduled cron jobs
Examples:
# Run all cron jobs
php aeros run:cron --all

# Run a specific cron job
php aeros run:cron CacheCleanup

Creating Custom Commands

You can create your own CLI commands using make:command:
php aeros make:command SendEmails
This generates a new command class in app/commands/ that you can customize. See Make Commands for more details.

Next Steps

Scaffolding Commands

Learn about make:* commands for code generation

Database Management

Explore migration and seeding commands

Build docs developers (and LLMs) love