Documentation
Guides and reference for cmdk-engine. New here? Start with Getting Started.
Overview
- Getting Started: Install, register commands, add the palette and the shortcut.
- Styling: Starter CSS and Tailwind, class name props and the attributes you can target.
Guides
- Next.js: Use the palette in the App Router: a client file, router.push and [locale] routes.
- shadcn/ui: Add the palette to a shadcn project as a registry item, for cmdk or Base UI.
- Search: How results are found and ranked, synonyms, match-sorter and custom engines.
- Nesting and groups: Sub-menus with breadcrumbs, and headings for long command lists.
- CLI: Scan your route files into a sitemap, from the command line or CI.
Reference
- API Reference: The provider, every option, the command object and the hooks.
- Core API: The framework-agnostic building blocks: registry, frecency, groups and more.
- Adapters: The cmdk, Base UI and React Router adapters, with props and differences.
- Examples: React Router, RBAC, a custom UI and a pre-commit hook.