Getting Started

The Global Search plugin provides a unified search experience across all Vendure entities -- products, orders, customers, collections, assets, and any custom entities registered by other plugins. It powers the Command Palette (Cmd+K / Ctrl+K) in the Admin Dashboard, combining full-text search with context-aware keyboard shortcuts.

Core Concepts

• Global Search Index -- A Typesense-backed index that aggregates searchable data from multiple entity types into a single collection, powered by the Advanced Search plugin's External Index mechanism.
• Index Entry -- A GlobalSearchIndexEntry defines how a specific entity type is indexed. It uses heuristics to auto-detect label, description, and thumbnail fields, or accepts explicit configuration.
• Command Registry -- A client-side registry where dashboard views can register keyboard shortcuts that appear in the command palette alongside search results.
• Command Palette -- The Cmd+K dialog that combines global search with registered commands.