README

A Spotlight/CMD+K style command palette for quick navigation and actions across Filament panels.

Features

Keyboard shortcut: Press Cmd+K (Mac) or Ctrl+K (Windows/Linux) to open
Quick navigation: Jump to any page, resource, or navigation item
Search: Filter commands by typing
Keyboard navigation: Use arrow keys and Enter to select
Optional topbar button: Click to open from the topbar

Installation

composer require usamamuneerchaudhary/filament-command-palette

Setup

use Usamamuneerchaudhary\CommandPalette\FilamentCommandPalettePlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentCommandPalettePlugin::make(),
            // ...
        ]);
}

Configuration

Publish the config file (optional):

php artisan vendor:publish --tag=command-palette-config

Options in config/command-palette.php:

key_bindings: Keyboard shortcuts (default: ['mod+k'])
show_topbar_button: Show optional trigger in topbar (default: true)
max_results: Max results per category (default: 10)
include_publish_views_command: Show "Publish views" in the command palette (default: true)
custom_commands: Array of closures returning CommandItem[] for extensibility

Publishing Views

You can publish the package views to customize the command palette layout, styling, and behavior. Published views go to resources/views/vendor/command-palette/ and can be edited freely.

From the command palette: Open the palette (Cmd+K), search for "Publish views", and select it to open a page with a one-click publish button.

From the terminal:

php artisan command-palette:publish-views

Or using Laravel's vendor publish directly:

php artisan vendor:publish --tag=command-palette-views

Use --force to overwrite existing published views.

Custom Commands

Add custom commands via config:

'custom_commands' => [
    fn () => [
        \Usamamuneerchaudhary\CommandPalette\Support\CommandItem::make(
            'My Action',
            '/my-url',
            'Custom',
        ),
    ],
],

usamamuneerchaudhary / filament-command-palette

Maintainers

Details