Skip to content

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'),
])

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.