CLI Reference

Version 1.0.0

Command-line interface for the Modular Architecture package

Global Options

All commands support these global options:

Option Description
-h, --help Display help for the command
-q, --quiet Do not output any message
-V, --version Display application version
--ansi Force ANSI output
-n, --no-interaction Do not ask any interactive question
-v, -vv, -vvv Increase verbosity level

Generator Command Format

All generator commands follow this pattern:

php artisan modular:make-{type} {name} {module}
Argument Description
name The name of the class to create
module The target module name

Example

php artisan modular:make-service OrderService Orders

Creates Modules/Orders/app/Services/OrderService.php

Commands

modular:make

$ modular:make

Create a new module with optional scaffolding

Arguments

name
The name of the module

Options

Flag Type Default Description
boolean - Module version (default: 1.0.0)
boolean - Module description
boolean - Use interactive mode
boolean - Generate a model
boolean - Generate a controller
boolean - Generate views
boolean - Generate routes
boolean - Generate config
boolean - Generate tests
boolean - Generate all components

Examples

modular:list

$ modular:list

List all discovered modules

Options

Flag Type Default Description
boolean - Show only enabled modules
boolean - Show only disabled modules

Examples

modular:enable

$ modular:enable

Enable a module

Arguments

name required
Module name to enable

Examples

modular:disable

$ modular:disable

Disable a module

Arguments

name required
Module name to disable

Examples

modular:status

$ modular:status

Show detailed status of a module

Arguments

name required
Module name

Examples

modular:validate

$ modular:validate

Validate module configurations

Arguments

name
Module name (optional, validates all if not specified)

Examples

modular:dependents

$ modular:dependents

Show modules that depend on a given module

Arguments

name required
Module name

Examples

modular:health

$ modular:health

Run health checks on modules

Examples

modular:migrate

$ modular:migrate

Run migrations for modules

Arguments

name
Module name (optional)

Examples

modular:seed

$ modular:seed

Run seeders for modules

Arguments

name
Module name (optional)

Examples

modular:bridges

$ modular:bridges

List all framework bridges and their status

Options

Flag Type Default Description
boolean - Show only enabled bridges
boolean - Show only available bridges

Examples

modular:bridges:inspect

$ modular:bridges:inspect

Inspect a specific bridge in detail

Arguments

name required
Bridge name

Examples

modular:bridges:cache

$ modular:bridges:cache

Cache bridge discovery data

Examples

modular:bridges:clear

$ modular:bridges:clear

Clear bridge cache

Examples

modular:cache

$ modular:cache

Cache module discovery

Examples

modular:cache:clear

$ modular:cache:clear

Clear module cache

Examples

modular:optimize

$ modular:optimize

Optimize modules for production

Examples