Skip to content

Capell CLI Command Index

This page is the short command map for the host packages in this repository. Run php artisan list capell inside an installed app for the live command list, including optional add-on packages.

CommandUse it for
capell:installRun the main installer, optional demo setup, package setup, and first user
capell:upgradeRun Capell upgrade phases, migrations, registered steps, and cache cleanup
capell:rollbackRoll back a recorded upgrade step
capell:doctorRun installation and environment checks
capell:healthRun bounded operational checks (--json for monitoring)
capell:publish-migrationsPublish Capell migrations or selected migration files
capell:delete-migrationsDelete published migration files for an extension
capell:publish-componentsPublish frontend Blade component views
capell:cache-componentsCache registered component metadata
capell:clear-components-cacheClear cached component metadata
capell:package-cacheRefresh cached installed package metadata
capell:package-cache:clearClear cached installed package metadata
CommandUse it for
capell:extension-installRun install workflows for one or more installed extension packages
capell:extension-uninstallUninstall extensions, optionally deleting extension data or Composer packages
capell:extensions:repair-composer-driftRepair Composer-actionable drift between capell_extensions and Composer state
capell:extension-auditValidate a package directory or capell.json against extension contracts
capell:extension-playgroundInspect an extension from a package name, directory, or manifest path
capell:package:lintLint package manifests, naming, versions, assets, and extension contracts
capell:make:extensionScaffold a local package with a minimal or full manifest profile
capell:make:themeScaffold a theme with conditional frontend CSS registration
CommandUse it for
capell:makePreview or run any maker registered in MakerRegistry
capell:make-actionGenerate an Action class under App\Actions
capell:make-dataGenerate a Laravel Data class under App\Data
capell:make-extenderGenerate a PageSchemaExtender
capell:make-schemaGenerate a schema class
capell:make-blueprintGenerate a page blueprint class

The maker hub accepts --dry-run, --force, --name=, --type=, --source=, --livewire, and --database where a maker supports them. Use capell:make --dry-run before writing files when you are checking a generator.

CommandUse it for
capell:fakerCreate local test content, optionally including package-provided data
capell:core-fakerCreate core-only local test content

These are development helpers. Do not run them against production data.

CommandUse it for
capell:admin-installInstall admin package requirements and optionally integrate a panel
capell:admin-setupCreate initial admin data and wire Capell into a Filament panel
capell:admin-upgradeRun admin package upgrade work
capell:admin-upgrade-summary-emailSend the configured upgrade summary notification
capell:admin-clear-cacheClear Capell admin cache and package cache
capell:admin-cache-widgetsCache discoverable admin widgets
capell:admin-clear-widgets-cacheClear discoverable admin widget cache
capell:admin-cache-configuratorsCache registered configurators
capell:admin-clear-configurators-cacheClear registered configurator cache
capell:admin-publish-resourcesPublish selected admin resources for advanced app-level customisation

Do not use older schema publishing commands unless the installed package version still exposes them. Current admin customisation should prefer configurators, extenders, bridges, and resource contributions.

CommandUse it for
capell:frontend-installRun frontend install work
capell:frontend-after-installBuild frontend assets after package install
capell:frontend-upgradeRun frontend package upgrade work

Static-site generation, sitemap generation, Tailwind aggregation, and demo commands are supplied by optional packages in a consuming app. Treat php artisan list capell as the source of truth for that install.

Common optional owners:

CommandPackage
capell:static-sitecapell-app/html-cache
capell:xml-sitemapcapell-app/site-discovery
capell:frontend-tailwind-assetscapell-app/frontend
capell:admin-democapell-app/demo-kit
capell:demo-kit-full-democapell-app/demo-kit

These commands are defined in the root composer.json or package.json:

ScriptUse it for
composer prepareDiscover Testbench packages
composer test:fastRun the sharded fast Pest command while developing
composer testRun the full Pest test suite
composer lintApply Pint formatting across the repository (alias of cs:fix)
composer lint:changedRun Pint, Prettier, and ESLint over changed files only
composer analyzeRun the full PHPStan configuration (alias of analyze:full)
composer analyze:sourceAnalyse package source only — the fast iteration loop, not a gate
composer analyze:testsAnalyse test suites only — the fast iteration loop, not a gate
composer preflightRun all standard gates and report every independent failure
composer preflight:allApply Rector and Pint, then report all repository-wide gate failures
composer preflight:fixApply Rector, Pint, and Prettier changes, then run preflight:all
composer check:root-docsEnsure no unexpected Markdown files are added to the repository root
composer check:docs-linksEnsure all relative documentation links resolve
composer check:docs-orphansEnsure every docs page is reachable from the docs entry points
composer check:docs-requirementsEnsure requirement tables agree with composer.json constraints
composer check:docs-commandsValidate fenced Foundation Artisan examples against the live command registry
composer check:docs-envEnsure documented env vars are read by code or explicitly allowlisted
composer serveBuild and serve the Testbench workbench
npm run screenshotsCapture docs screenshots through the configured screenshot runner
npm run screenshots:checkValidate docs screenshot manifests through the configured screenshot runner
npm run docs:publishSync the local core docs into the external docs app and build it

The formatting, Rector and analysis script names mean the same thing in capell-4 and capell-packages-4. cs:fix and cs:check are the real Pint definitions; lint and lint:check are aliases of them. rector (alias of rector:all) is a full write, rector:changed a changed-file write, rector:check a changed-file dry run and rector:all:check a full dry run. analyze is analyze:full; analyze:source is the fast iteration loop.

  • Host and container share the bind-mounted repo, and phpstan.neon pins tmpDir to var/phpstan/full. A cache holding paths from the other context raises internal errors such as phar:///home/capell/current/... is not a file; it is a cache collision, not a code error. Docker masks var/ with the capell-var named volume to keep the two apart, so do not delete the volume to share a cache. A worktree has its own var/, so the same branch can pass there and fail in the primary checkout; compare the cached path provenance before reading code.
  • scripts/ run straight from the PHP binary and mostly do not load the Composer autoloader, so Rector rules that assume a booted application (facade, throw_if, sleep() and time() rewrites) produce code that fatals; rector.php skips those rules for scripts/. rector:changed only visits changed files (the committed diff against the base branch, or staged files with --staged), so run rector:all after any Rector or rector-laravel bump.
  • Host commands use capell:<name> or capell:<package>-<verb>.
  • Optional add-ons may add their own capell:<package>-<verb> commands.
  • Do not copy command names from old planning notes; check the source or run php artisan list capell so command documentation reflects shipped behaviour.

The docs command gate discovers fenced php artisan capell:* examples across the Markdown tree. Put <!-- capell-docs-commands: optional-package --> immediately before a fence only when its command is registered by a separately installed companion package; the gate rejects that marker for commands already registered by Foundation.

See Artisan commands for the longer command reference with common options.