70 lines
2.5 KiB
Plaintext
70 lines
2.5 KiB
Plaintext
---
|
|
title: Registry Directory
|
|
description: Open Source Registry Index
|
|
---
|
|
|
|
The open source registry index is a list of all the open source registries that are available to use out of the box.
|
|
|
|
When you run `shadcn add` or `shadcn search`, the CLI will automatically check the registry index for the registry you are looking for and add it to your `components.json` file.
|
|
|
|
You can see the full list at [https://ui.shadcn.com/r/registries.json](https://ui.shadcn.com/r/registries.json).
|
|
|
|
You do not need to submit a public GitHub registry to the registry directory to
|
|
use it with `owner/repo/item` addresses. The registry directory is for
|
|
namespaces such as `@acme`.
|
|
|
|
## Adding a Registry
|
|
|
|
1. Add your registry to [`apps/v4/registry/directory.json`](https://github.com/shadcn-ui/ui/blob/main/apps/v4/registry/directory.json)
|
|
2. Run `pnpm validate:registries` to validate the registry directory.
|
|
3. Create a pull request to https://github.com/shadcn-ui/ui
|
|
|
|
Once you have submitted your request, it will be validated and reviewed by the team.
|
|
|
|
Once the pull request is merged, your registry is published immediately.
|
|
[Registry Health](/docs/registry/health) starts monitoring it after publication
|
|
and does not delay or gate publication while it collects baseline data.
|
|
|
|
## Requirements
|
|
|
|
1. The registry must be open source and publicly accessible.
|
|
2. The registry must be a valid JSON file that conforms to the [registry schema specification](/docs/registry/registry-json).
|
|
3. The registry is expected to be a flat registry with no nested items i.e `/registry.json` and `/component-name.json` files are expected to be in the root of the registry.
|
|
4. The `files` array, if present, must NOT include a `content` property.
|
|
|
|
Here's an example of a valid registry:
|
|
|
|
```json title="registry.json" showLineNumbers
|
|
{
|
|
"$schema": "https://ui.shadcn.com/schema/registry.json",
|
|
"name": "acme",
|
|
"homepage": "https://acme.com",
|
|
"items": [
|
|
{
|
|
"name": "login-form",
|
|
"type": "registry:component",
|
|
"title": "Login Form",
|
|
"description": "A login form component.",
|
|
"files": [
|
|
{
|
|
"path": "registry/new-york/auth/login-form.tsx",
|
|
"type": "registry:component"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "example-login-form",
|
|
"type": "registry:component",
|
|
"title": "Example Login Form",
|
|
"description": "An example showing how to use the login form component.",
|
|
"files": [
|
|
{
|
|
"path": "registry/new-york/examples/example-login-form.tsx",
|
|
"type": "registry:component"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|