Skip to content

No results for

↑ ↓ navigate ↵ open Esc close

Overview

The aura-filament:install command is the fastest way to set up Aura Filament. It prompts you for your preferred preset, primary color, icon set, and font, then:

  • Publishes the config file
  • Appends the CSS import to resources/css/app.css
  • Detects your panel provider and registers AuraFilamentPlugin automatically

The command is idempotent — running it twice is safe and won't duplicate imports or plugin registrations.

Usage

After installing the package via Composer:

php artisan aura-filament:install

You will be prompted through each step:

╭─────────────────────────────────────────╮
│   Welcome to Aura Filament installer    │
╰─────────────────────────────────────────╯

 ┌ Which preset do you want as default? ────────────────────┐
 │ › Glass — modern glassmorphism (recommended)             │
 │   Corporate — clean enterprise                           │
 │   Warm — friendly B2C                                    │
 │   Midnight — dev/tech                                    │
 └──────────────────────────────────────────────────────────┘

 ┌ Primary color? (any Filament Color constant) ────────────┐
 │ › Blue                                                   │
 └──────────────────────────────────────────────────────────┘

 ┌ Which icon set? ─────────────────────────────────────────┐
 │ › Heroicon — Filament default (no extra install)         │
 │   Phosphor — 7,488 icons (recommended)                   │
 │   Iconoir — 1,680 icons                                  │
 │   Lucide — 1,500+ icons                                  │
 └──────────────────────────────────────────────────────────┘

Non-interactive mode

Pass options on the CLI to skip all prompts:

php artisan aura-filament:install \
    --preset=glass \
    --color=Violet \
    --icons=phosphor \
    --font=Inter \
    --no-interaction

Available options

Option Values
--preset glass, corporate, warm, midnight
--color Any Filament Color constant (Blue, Violet, Emerald, ...)
--icons heroicon, phosphor, iconoir, lucide
--font A Google Font name, or none to skip
--panel Panel provider basename (e.g. AdminPanelProvider)
--no-interaction Use defaults, no prompts

After running

The command:

  1. Creates config/aura-filament.php

  2. Adds to resources/css/app.css:

    /* Aura Filament */
@import '../../vendor/bluestarsystem/aura-filament/resources/css/aura-filament.css';
@source '../../vendor/bluestarsystem/aura-filament/resources/views/**/*.blade.php';

  3. Injects into your app/Providers/Filament/AdminPanelProvider.php:

    ->plugins([
    \BlueStarSystem\AuraFilament\AuraFilamentPlugin::make()
        ->preset(\BlueStarSystem\AuraFilament\Enums\Preset::Glass)
        ->primaryColor(\Filament\Support\Colors\Color::Blue)
        ->font('Inter'),
])

  4. Publishes the Aura user-preference migrations (aura_theme_preferences, aura_dashboard_layout)

  5. Wires the HasAuraThemePreferences + HasAuraDashboardLayout traits into your User model

Complete starter

aura-filament:install leaves your panel fully wired: plugin registered, theme CSS imported, and the per-user theme & dashboard preference persistence set up (migrations + User traits). After running it:

php artisan migrate

--demo

Pass --demo to drop in ready-made pages (an analytics dashboard and a settings page) via the scaffold generator:

php artisan aura-filament:install --demo

Next steps

Run npm run build (or npm run dev) to compile the CSS, then visit your Filament panel to see the new look.

If the installer can't detect your panel provider (custom location or filename), it prints manual registration instructions.

Check the result: aura-filament:doctor

php artisan aura-filament:doctor

Filament theming fails quietly. If the plugin never got registered, or the CSS never reaches the panel, or the theme was not compiled, the panel just keeps Filament's default look — no error, nothing in the logs. aura-filament:doctor finds those states:

Check What it catches
plugin No panel provider registers AuraFilamentPlugin, so the theme never loads. This is the state the installer warns about when it cannot auto-detect your panel.
panel-theme Your panel declares viteTheme('…/theme.css') but that file does not import aura-filament.css — or does not exist.
css Nothing imports the theme anywhere: no panel theme and no resources/css/app.css import.
preset The configured preset is not a real one.
build public/build/manifest.json is missing, so the theme was never compiled.

It exits non-zero when it finds an error, so you can gate CI on it, and takes --json for machine-readable output.

Both valid layouts are understood: the theme may live in the panel's viteTheme file — the idiomatic Filament setup, where app.css has no reason to import it — or in app.css when no panel declares a custom theme.