Installation

Install the package

npm install cmdk

yarn add cmdk

pnpm add cmdk

bun add cmdk

Peer dependencies

cmdk requires React and ReactDOM as peer dependencies. Both React 18 and React 19 (including release candidates) are supported.

Package	Version
`react`	`^18 \|\| ^19 \|\| ^19.0.0-rc`
`react-dom`	`^18 \|\| ^19 \|\| ^19.0.0-rc`

If your project already has React installed, no additional action is needed.

Radix UI dependencies

cmdk uses several Radix UI primitives internally. These are listed as regular dependencies and are installed automatically when you install cmdk.

Package	Purpose
`@radix-ui/react-dialog`	Powers `Command.Dialog` overlay
`@radix-ui/react-compose-refs`	Ref merging utility
`@radix-ui/react-id`	Stable ID generation
`@radix-ui/react-primitive`	Base primitive components

You do not need to install these packages separately.

Client component requirement

cmdk is a client component — it cannot be used in React Server Components. Add 'use client' to any component that imports cmdk.

Next.js App Router

In the Next.js App Router, all components are Server Components by default. Add the 'use client' directive at the top of any file that imports from cmdk.

'use client'

import { Command } from 'cmdk'

export function CommandMenu() {
  return (
    <Command>
      <Command.Input />
      <Command.List>
        <Command.Item>Example</Command.Item>
      </Command.List>
    </Command>
  )
}

You can keep 'use client' scoped to a single wrapper component and import that component from your Server Components freely.

Vite / Create React App

In projects where all components are client components by default (Vite, Create React App, etc.), no extra configuration is needed. Import and use cmdk directly.

import { Command } from 'cmdk'

export function CommandMenu() {
  return (
    <Command>
      <Command.Input />
      <Command.List>
        <Command.Item>Example</Command.Item>
      </Command.List>
    </Command>
  )
}

⌘I

Get Started

Components

Guides

Examples

Installation

Install the package

Peer dependencies

Radix UI dependencies

Client component requirement

Next.js App Router

Vite / Create React App

​Install the package

​Peer dependencies

​Radix UI dependencies

​Client component requirement

​Next.js App Router

​Vite / Create React App

Install the package

Peer dependencies

Radix UI dependencies

Client component requirement

Next.js App Router

Vite / Create React App