Skip to content

Console Command Conventions ​

Class names must reflect their command signature. Convert signature parts to PascalCase and append Command.

Naming Rules ​

Signature PartClass Name PartExample
modularous:make:moduleMakeModuleCommandmake + module
modularous:cache:clearCacheClearCommandcache + clear
modularous:route:disableRouteDisableCommandroute + disable

Semantic Rules ​

modularous:make:* — Artifact generators ​

Commands that scaffold or generate files. All live in Console/Make/.

  • Class: Make*Command (e.g. MakeModuleCommand, MakeControllerCommand)
  • Examples: make:module, make:controller, make:migration

modularous:create:* — Runtime creation ​

Commands that create runtime records (DB entries, users).

  • Class: Create*Command (e.g. CreateSuperAdminCommand)
  • Examples: create:superadmin

Other namespaces ​

NamespacePatternExample
modularous:cache:*Cache*CommandCacheClearCommand
modularous:migrate:*Migrate*CommandMigrateCommand
modularous:flush:*Flush*CommandFlushCommand
modularous:route:*Route*CommandRouteDisableCommand
modularous:sync:*Sync*CommandSyncTranslationsCommand, SyncRemoteApiCommand
modularous:replace:*Replace*CommandReplaceRegexCommand

Class Naming by Folder ​

FolderPatternExample
Console/ (root)*CommandBuildCommand, ReplaceRegexCommand
Make/Make*CommandMakeModuleCommand
Cache/Cache*CommandCacheClearCommand
Migration/Migrate*CommandMigrateCommand
Module/*CommandRouteDisableCommand
Roles/Roles*CommandRolesLoadCommand
Setup/*CommandInstallCommand, CreateSuperAdminCommand
Seed/Seed*CommandSeedPaymentCommand
Sync/Sync*CommandSyncTranslationsCommand
Operations/*CommandProcessOperationsCommand
Flush/Flush*CommandFlushCommand
Update/Update*CommandUpdateLaravelConfigsCommand
Docs/Generate*CommandGenerateCommandDocsCommand
Schedulers/*Command(package root)

Command Mapping ​

SignatureClass
modularous:make:*Make*Command
modularous:create:superadminCreateSuperAdminCommand
modularous:create:databaseCreateDatabaseCommand
modularous:installInstallCommand
modularous:setup:developmentSetupModularousDevelopmentCommand
modularous:cache:listCacheListCommand
modularous:cache:clearCacheClearCommand
modularous:cache:versionsCacheVersionsCommand
modularous:cache:graphCacheGraphCommand
modularous:cache:statsCacheStatsCommand
modularous:cache:warmCacheWarmCommand
modularous:cache:warm-presentationCacheWarmPresentationCommand
modularous:flushFlushCommand
modularous:flush:sessionsFlushSessionsCommand
modularous:flush:filepondFlushFilepondCommand
modularous:route:disableRouteDisableCommand
modularous:route:enableRouteEnableCommand
modularous:fix:moduleFixModuleCommand
modularous:remove:moduleRemoveModuleCommand
modularous:replace:regexReplaceRegexCommand
modularous:db:check-collationCheckDatabaseCollationCommand