Templates
Learn how to install our templates code directly in your shadcn/ui project with the CLI.
Installation
You can install Templates with the latest shadcn CLI 3.0.
- Ensure shadcn/ui is installed in your project. If not, install it now.
- Find and copy your license key. If you purchased the Premium package, you can find it in My Orders page after logging in to Lemon Squeezy.
- In your project root, create
.env.local
file with the content:SHADCNDESIGN_LICENSE_KEY=your_key_from_lemonsqueezy
- Update your components.json file by adding our registry as presented below.
{
"$schema": "https://ui.shadcn.com/schema.json",
"style": "new-york",
"rsc": true,
"tsx": true,
"tailwind": {
"config": "",
"css": "app/globals.css",
"baseColor": "neutral",
"cssVariables": true,
"prefix": ""
},
"iconLibrary": "lucide",
"aliases": {
"components": "@/components",
"utils": "@/lib/utils",
"ui": "@/components/ui",
"lib": "@/lib",
"hooks": "@/hooks"
},
"registries": {
"@shadcndesign": {
"url": "https://shadcndesign-registry.vercel.app/api/registry/{name}",
"headers": {
"X-License-Key": "${SHADCNDESIGN_LICENSE_KEY}"
}
}
}
}
- Install our styles:
npx shadcn@latest add @shadcndesign/styles
- That's it, you are ready to go! You can install the templates by following the examples below.
# Install Inspiro template
npx shadcn@latest add @shadcndesign/template-inspiro
# Install Developer Portfolio template
npx shadcn@latest add @shadcndesign/template-developer-portfolio
---
Below is the deprecated method that will be unsupported soon.
Installation (Deprecated method)
- Make sure to install shadcn/ui, if you haven't already.
- Copy the CLI command for the template you want to install:
- Inspiro Template:
npx shadcn@latest add "https://shadcndesign-pro-blocks.vercel.app/components?name=shadcndesign-template-inspiro&key=YOUR_LICENSE_KEY"
- Developer Portfolio Template:
npx shadcn@latest add "https://shadcndesign-pro-blocks.vercel.app/components?name=shadcndesign-template-inspiro&key=YOUR_LICENSE_KEY"
- Inspiro Template:
- Paste the CLI command in your shadcn/ui project’s terminal.
- Find and copy your license key. If you purchased the Premium package, you can find it in My Orders page after logging in to Lemon Squeezy.
- Paste your license key after the “key=” in your project’s terminal.
- Run the command and follow the instructions in the terminal. If your license key is valid, all template pages and components will be installed in your project.