Skip to content

Overview

Aura Filament ships a fast command palette activated with Cmd+K (Mac) or Ctrl+K (Windows/Linux).

It auto-populates with:

  • All resources registered on the current panel
  • All pages registered on the current panel
  • Any custom items added via the CommandPalette facade

The search runs entirely client-side (Alpine.js), so results appear instantly. There's no server round-trip.

Keyboard shortcuts

Key Action
Cmd+K / Ctrl+K Open the palette
/ Navigate results
Enter Open the selected item
Escape Close the palette

Enabling and disabling

The command palette is enabled by default. Disable it if you need to:

AuraFilamentPlugin::make()
    ->commandPalette(false)

Adding custom items

Register a closure in any service provider. It runs on every open, so it can react to the current user or request:

use BlueStarSystem\AuraFilament\Facades\CommandPalette;

public function boot(): void
{
    CommandPalette::addSource(function () {
        return [
            [
                'label' => 'Export monthly report',
                'url' => route('reports.export'),
                'icon' => 'phosphor-download',
                'group' => 'Reports',
            ],
            [
                'label' => 'Clear caches',
                'url' => route('admin.caches.clear'),
                'icon' => 'phosphor-trash',
                'group' => 'System',
            ],
        ];
    });
}

Item shape

Key Required Description
label yes Displayed text (searchable)
url yes Destination URL
icon no Blade icon name
group no Group header (default Custom)

Permissions

Items inherit the panel's existing visibility logic:

  • Resources respect canViewAny()
  • Pages respect canAccess()
  • Custom sources run on every request — filter there with auth()->user()
CommandPalette::addSource(function () {
    if (! auth()->user()?->can('export-reports')) {
        return [];
    }

    return [
        ['label' => 'Export report', 'url' => route('reports.export')],
    ];
});