Capell Core
Package docs status
Section titled “Package docs status”This page is generated from public package documentation in capell-4 core packages and the package manifest checked into the source repository.
| Field | Value |
|---|---|
| Composer package | capell-app/core |
| Package slug | core |
| Product group | Capell Foundation |
| Tier | free |
| Bundle | foundation |
| Runtime contexts | admin, frontend, console |
| Capell version | ^4.0 |
| Source repository | capell-app/capell |
| Source path | packages/core |
| Docs source | packages/core/docs |
| Manifest | capell.json |
capell-app/core is the platform package for Capell CMS. It owns the shared content model, package registry, install and upgrade orchestration, settings infrastructure, and extension contracts used by Admin, Frontend, Installer, Marketplace, and first-party add-ons.
Use this package when a Laravel app needs Capell’s domain records and extension API. It is not an editor UI or public renderer by itself.
Package Boundary
Section titled “Package Boundary”Core owns:
- sites, domains, languages, pages, page URLs, layouts, themes, blueprints, media records, redirects, package state, and upgrade log records
- install, upgrade, rollback, package cache, component cache, doctor, faker, and maker commands
- package manifest validation, package registry state, settings schemas, subscribers, render blocks, maker registration, and model-level contracts
- database migrations and settings migrations for the shared Capell schema
Core does not own:
- the Filament admin panel, resources, dashboard surfaces, and editor workflow; that is
capell-app/admin - public request handling and public HTML rendering; that is
capell-app/frontend - browser installer routes and setup removal; that is
capell-app/installer - catalogue browsing, account linking, domain verification, and install authorization; that is
capell-app/marketplace - visual layout building, frontend authoring, generated HTML cache, SEO, blog, navigation, or backup features; those live in add-on packages
Install
Section titled “Install”composer require capell-app/corephp artisan capell:installcapell:install coordinates the foundation install flow. On an existing Capell app, use:
php artisan capell:upgradephp artisan capell:doctorUse php artisan list capell in the host app to confirm the exact command set available after Composer discovery.
Runtime Surfaces
Section titled “Runtime Surfaces”- Provider:
Capell\Core\Providers\CapellServiceProvider - Config:
packages/core/config/capell.php,packages/core/config/audit.php,packages/core/config/redirects.php - Main models:
Page,PageUrl,Site,SiteDomain,Language,Layout,Theme,Blueprint,Type,Media,CapellExtension,UpgradeLogEntry - Main commands:
capell:install,capell:upgrade,capell:rollback,capell:doctor,capell:package-cache,capell:package-cache:clear,capell:publish-migrations,capell:publish-components,capell:make-* - Test case support:
Capell\Core\Testing\ExtensionTestHarness
Type remains present for compatibility while the admin surface is moving toward Blueprint naming. New docs and UI copy should prefer Blueprint unless they are documenting a compatibility API that still uses type terminology.
Extension Points
Section titled “Extension Points”Use Core extension points instead of patching first-party models or providers:
| Need | Extension point |
|---|---|
| Register a page subject type | CapellCore::registerPageType(new PageTypeData(...)) |
| Register package settings | SettingsSchemaRegistry::register() |
| Register renderable definitions | RenderableRegistry::register() |
| Subscribe to lifecycle events | SubscriberManager::subscribe() |
| Register cache dependencies | CacheInvalidationRegistry::registerDependency() |
| Register Tailwind source/import metadata | TailwindAssetsRegistry::registerSource() / registerImport() |
| Create package files from project patterns | capell:make-* maker commands |
When adding a Core migration, also append it to packages/core/src/Concerns/HasMigrations.php; otherwise package installs can miss the migration.
Data And Persistence
Section titled “Data And Persistence”Core is schema-owning. It creates the tables used by most Capell packages, including page, site, language, layout, theme, blueprint, media, extension, redirect, audit, and upgrade state.
Settings migrations are part of package installation and must be idempotent. Wrap new settings migrations in existence checks so upgrades and fresh installs behave the same way.
Core records are used by public rendering and admin workflows, so avoid adding admin-only assumptions to models, casts, or public serialization paths.
Verification
Section titled “Verification”Run the smallest relevant check first:
vendor/bin/pest packages/core/tests --configuration=phpunit.xmlFor shared contract changes, also run the package boundary and manifest tests:
vendor/bin/pest packages/core/tests/Arch packages/core/tests/Unit/Manifest --configuration=phpunit.xmlBefore landing broader Core changes, run the repo preflight command:
composer preflightTroubleshooting
Section titled “Troubleshooting”- Missing package surfaces usually mean Composer discovery or the Capell package cache is stale. Run
composer dump-autoload, thenphp artisan capell:package-cache:clear. - New migrations that work in tests but not on install are usually missing from
HasMigrations::getMigrations(). - Missing default page records or Blueprint warnings should be checked with
php artisan capell:doctorbefore changing seed or setup code. - Do not document moved features as Core behavior. Publishing Studio, generated HTML cache, site discovery, frontend authoring, SEO, blog, navigation, and backup workflows are package-owned.
Further Reading
Section titled “Further Reading”| Page | Covers |
|---|---|
| Core overview | Core responsibilities and the package docs index. |
| Page management | Pages, URLs, types, and publishing state. |
| Content management | Shared content records and ownership boundaries. |
| Extending Capell | Core contracts and extension surfaces. |
| Cache | Shared cache helpers and invalidation behavior. |
| Multi-site and multi-lingual | Sites, domains, languages, and localized URLs. |
| Subscriber manager | Lifecycle subscription registration. |
| Static-site extensions | Static export integration points. |
| Authoring upgrade steps | Upgrading packages that integrate authoring behavior. |
| Install debugging | Common install and setup failures. |
| Package authoring docs | Package shape, service providers, Actions/Data/settings, migrations, and tests. |
| Approved packages catalog | Host packages and first-party add-on catalogue. |