Artisan Commands

AdminLTE 4 for Laravel registers four Artisan commands. They handle installation, status reporting, section scaffolding, and authentication scaffolding.

For deep coverage of scaffolding see scaffolding.md, and for authentication see authentication.md.

adminlte:install

Installs the core AdminLTE 4 scaffolding: the config file, the Vite CSS/JS entry stubs, and the frontend npm dependencies (with vendor plugin files copied into public/vendor).

Signature

adminlte:install
    {--only= : Install only a specific resource (config|views|assets|lang)}
    {--force : Overwrite existing files}
    {--no-interaction-deps : Skip the npm install prompt}

Options

Note: When --only is omitted, the command publishes config and assets (and wires Vite), then runs the frontend dependency installer. The views and lang resources are published only when explicitly requested via --only=views / --only=lang.

What it publishes

The publishable tags (defined in AdminLteServiceProvider):

Vite wiring

After publishing assets, the installer inspects vite.config.js:

• If the file does not exist, nothing happens.
• If it already references resources/js/adminlte.js, it is left alone.
• Otherwise it prints a warning asking you to add resources/css/adminlte.css and resources/js/adminlte.js to the laravel({ input: [...] }) array.

The installer never rewrites vite.config.js automatically (to avoid clobbering custom configs).

Frontend dependencies (npm)

When run without --only and without --no-interaction-deps, the command prompts:

Install frontend dependencies (admin-lte, bootstrap, plugin libraries, etc.) via npm now?

If accepted, it runs:

npm install -D admin-lte@^4.8 bootstrap@^5.3 @popperjs/core@^2.11 overlayscrollbars@^2.16 \
  bootstrap-icons@^1.13 apexcharts@^6.8 jsvectormap@^1.7 fullcalendar@^6.1 \
  sortablejs@^1.15 sass@^1.102

Every dependency is pinned to the major version the package is built and tested against, so a fresh install can't pick up a breaking upstream major. fullcalendar is deliberately held below v7: that release drops the minified global bundle (index.global.min.js) in favour of an unminified all/global.js, and replaces the bundled CSS with a skeleton + theme + palette model, neither of which the calendar component supports yet.

The optional plugins — disabled by default in config/adminlte.php — are not installed automatically. The command prints this hint after installing:

npm install -D flatpickr@^4.6 tom-select@^2.6 tabulator-tables@^6.5 quill@^2.0
php artisan adminlte:install --only=assets

Both lines matter. npm install fetches the library; the second command copies it into public/vendor, which is where config('adminlte.plugins') points. Skip it and the plugin's <script> 404s, so the component that uses it (for example <x-adminlte-editor>) renders an empty box with nothing in the PHP log to explain why. Run php artisan adminlte:status to see which optional plugins are in place.

If the prompt is declined (or --no-interaction-deps is passed), the npm commands are printed for you to run manually. The vendor copy still runs, so re-running the installer after a manual npm install is all you need.

Vendor file copying

The command copies plugin files from node_modules into public/vendor (so they can be loaded directly by the layout and section views). Files that don't exist in node_modules are silently skipped, which is what makes --only=assets safe to re-run whenever you add a plugin.

The FullCalendar stylesheet (fullcalendar/index.global.min.css) ships inside this package rather than npm, and is copied from resources/vendor/ alongside the rest.

Next steps printed

1. Ensure resources/js/adminlte.js & resources/css/adminlte.css are in your vite.config.js input.
2. Run npm run dev (or npm run build).
3. Extend the layout in a view: @extends('adminlte::page')
4. Configure your sidebar menu in config/adminlte.php.

Examples

# Full install: config + assets + Vite check + npm deps (interactive)
php artisan adminlte:install

# Full install in CI / non-interactive (skip the npm prompt)
php artisan adminlte:install --no-interaction-deps

# Publish only the config file
php artisan adminlte:install --only=config

# Publish the views so you can customize them, overwriting existing files
php artisan adminlte:install --only=views --force

# Publish language files for translation overrides
php artisan adminlte:install --only=lang

adminlte:status

Reports which AdminLTE resources are present on disk. Read-only — it makes no changes.

Signature

adminlte:status

What it checks

Results are grouped, and each row shows a green ✓ (present) or a grey – (absent). Only the Required group being incomplete is a problem.

Required — what adminlte:install sets up:

Optional — opt-in extras; absent is a normal, fully working install:

Optional plugins — installed only if you use the matching component:

A missing required resource prints a warning to run php artisan adminlte:install; otherwise it prints "AdminLTE 4 is fully installed." A missing optional plugin prints the two commands that add it (npm install -D … then adminlte:install --only=assets) and is never treated as an error.

Example

php artisan adminlte:status

adminlte:scaffold

Scaffolds full pre-built sections (mailbox, chat, kanban, calendar, projects, file-manager, profile, settings, invoice, pricing, faq), publishing migrations, models, controllers, seeders, views, and routes per a declarative manifest.

Signature

adminlte:scaffold
    {section? : The section to scaffold}
    {--all : Scaffold all sections}
    {--force : Overwrite existing files}
    {--seed : Run seeders after publishing}

Options

Examples

# Interactive multi-select picker
php artisan adminlte:scaffold

# Scaffold one section
php artisan adminlte:scaffold kanban

# Scaffold one section, then migrate and seed demo data
php artisan adminlte:scaffold mailbox --seed

# Scaffold everything
php artisan adminlte:scaffold --all

# Re-scaffold and overwrite customizations
php artisan adminlte:scaffold projects --force

# Roles & permissions layer (HasRoles on User, users/roles UI), seeded
php artisan adminlte:scaffold rbac --seed

DB-backed sections also publish factories, form requests, policies, and feature tests alongside the model and controller — see scaffolding.md. The rbac section installs a dependency-free roles/permissions layer — see authorization.md.

See scaffolding.md for the full per-section manifest, the DB tables created, and the route group injected into routes/web.php.

adminlte:make-auth

Scaffolds authentication. In plain mode it publishes self-contained auth controllers and registers their routes; breeze and fortify print integration guidance.

Signature

adminlte:make-auth
    {--type=plain : Auth type (plain, breeze, fortify)}
    {--force : Overwrite existing files}

Options

An invalid --type value fails the command.

Examples

# Plain auth (controllers + routes)
php artisan adminlte:make-auth

# Plain auth, overwrite existing controllers
php artisan adminlte:make-auth --type=plain --force

# Breeze integration guidance
php artisan adminlte:make-auth --type=breeze

# Fortify integration guidance
php artisan adminlte:make-auth --type=fortify

See authentication.md for the published controllers, the registered routes, and the shipped auth views.