shadcn search - shadcn/ui

The search command (also available as list) searches for items across one or more registries. Use it to discover available components, themes, and other registry items.

Usage

shadcn search <registries...>

shadcn list <registries...>

Arguments

string[]

required

The registry names or URLs to search. Registry names must be prefixed with @.

Options

string

The working directory. Defaults to the current directory.

string

Query string to filter results.

number

default:"100"

Maximum number of items to display per registry.

number

default:"0"

Number of items to skip.

Examples

Search the default shadcn registry

shadcn search @shadcn

Search with a query

shadcn search @shadcn --query button

Output:

[
  {
    "name": "button",
    "type": "registry:ui",
    "description": "Displays a button or a component that looks like a button.",
    "registry": "@shadcn"
  }
]

Search multiple registries

shadcn search @shadcn @custom-registry

Limit results

shadcn search @shadcn --limit 10

Paginate results

shadcn search @shadcn --offset 20 --limit 10

Search by URL

shadcn search https://ui.shadcn.com/r

What it does

Reads your components.json (if it exists) or uses default configuration
Resolves registry URLs
Fetches the registry index
Filters results by query (if provided)
Applies limit and offset
Outputs results as JSON

Output structure

Each search result includes:

name - Item name
type - Registry type
description - Item description (if available)
registry - Registry identifier
meta - Additional metadata (if available)

Registry types

Search results can include:

registry:ui - UI components
registry:block - UI blocks and sections
registry:hook - React hooks
registry:lib - Library utilities
registry:theme - Themes
registry:style - Style systems
registry:base - Base configurations
registry:example - Example implementations

Working with custom registries

To search a custom registry, add it to your components.json:

{
  "registries": {
    "@my-registry": {
      "url": "https://my-registry.com/r"
    }
  }
}

Then search it:

shadcn search @my-registry

Or search directly by URL without configuration:

shadcn search https://my-registry.com/r

Use cases

Browse available components

shadcn search @shadcn | jq -r '.[].name' | sort

shadcn search @shadcn --query form

Count available items

shadcn search @shadcn | jq 'length'

Filter by type

shadcn search @shadcn | jq '.[] | select(.type == "registry:ui")'

Get component descriptions

shadcn search @shadcn | jq '.[] | {name, description}'

Working with output

The JSON output can be processed with jq:

# Get component names only
shadcn search @shadcn | jq -r '.[].name'

# Filter UI components
shadcn search @shadcn | jq '.[] | select(.type == "registry:ui")'

# Pretty print
shadcn search @shadcn | jq '.'

# Save to file
shadcn search @shadcn > components.json

Notes

Registry names must be prefixed with @
Supports partial components.json files
Works without a components.json file (uses defaults)
Automatically configures registries if needed
Search queries are case-insensitive
Results are always returned as JSON

⌘I

​Usage

​Arguments

​Options

​Examples

​Search the default shadcn registry

​Search with a query

​Search multiple registries

​Limit results

​Paginate results

​Search by URL

​What it does

​Output structure

​Registry types

​Working with custom registries

​Use cases

​Browse available components

​Find form-related components

​Count available items

​Filter by type

​Get component descriptions

​Working with output

​Notes