@directus-labs/command-palette-module/README.md

Command palette module for Directus.

# Command Palette Module

A full-featured Command Palette with global search for your Directus Studio.

![Search Demo](https://raw.githubusercontent.com/directus-labs/extensions/main/packages/command-palette-module/docs/search-demo.gif)

## Features

- **Keyboard Shortcuts**: Use the `Cmd/Ctrl + K` shortcut to open the Command Palette
- **Global Search**: Search for items from anywhere
- **Instant Navigation**: Jump to any item, collection, or data model setting with ease
- **Quick Actions**: Perform common actions like creating new items
- **Run Flows** Run context-aware flows from the Command Palette
- **Search Page** Dedicated search page for searching across all (configured) collections
- **Search Setup** Configure which collections are searchable and which fields are used for searching to optimize results

## Installation

Refer to the [Official Guide](https://docs.directus.io/extensions/installing-extensions.html) for details on installing the extension from the Marketplace or manually.

## Configuration

1. Enable the module in the Directus project settings
    ![Enable Module](https://raw.githubusercontent.com/directus-labs/extensions/main/packages/command-palette-module/docs/configuration-modules.png)
2. Navigate to the module settings and create the command palette field in the project settings
    ![Module Settings](https://raw.githubusercontent.com/directus-labs/extensions/main/packages/command-palette-module/docs/configuration-settings.png) 
3. Configure which collections are searchable and which fields are used for searching
    ![Search Setup](https://raw.githubusercontent.com/directus-labs/extensions/main/packages/command-palette-module/docs/configuration-collections.png)