DocsInstall
Install components
Install UpFork's components and landing pages into your React project with the shadcn CLI: your token, components.json, and the add command.
Updated This page as Markdown
Components and landing pages built with React install with the shadcn CLI, into your own project, where the code is yours to change. Free products install with one command and nothing else. Everything else installs with your UpFork token: you set a project up once, and after that each install is one command.
What it solves
The problem. Copying a component from a website gives you one file. Its npm packages, its styles, the shadcn/ui pieces it uses and its next version are left to you, and you find what's missing when the build fails.
What you get. One command writes every file where shadcn puts it, installs the packages and shadcn/ui components it needs, and merges its styles into your stylesheet. It's the same registry item UpFork installed into a fresh Next.js project and type-checked before you got it, and the code is yours to change.
How it grows. A project set up once installs anything else from UpFork with one command. Each install is counted on the product's page, so the numbers the next developer reads are real ones, and once you have a product, its page tells you of each new version (What's new).
What counts as an install. The shadcn CLI adding a product to a project, once for each command, or an AI assistant installing it through UpFork's MCP server. Programs that only read the registry, such as search indexes, directories and crawlers, can fetch the same files, and they aren't counted; neither are ZIP downloads, which count as downloads.
Free products: no account needed
A free product installs by its address, with no account, token or setup:
npx shadcn@latest add https://upfork.dev/r/<name>.json<name> is the last part of the product's address: for https://upfork.dev/products/crowdwall, it's crowdwall. Its page shows
the command, ready to copy, and so does what an AI assistant gets from UpFork's MCP server. After
installing, the CLI says what a free account adds: the product's AI prompt and its ZIP.
What you need for the rest
- A React project with Tailwind CSS that the shadcn CLI can install into. If it has no
components.jsonyet, runnpx shadcn@latest initin it first. - An UpFork account. It's free.
- For a paid product, the account that bought it.
Create a token
On Account → Access tokens, name a token after the computer or project it's for, and create it. Copy it straight away: it's shown only once.
- A token starts with
upf_and is 47 characters long. - You can have up to 10. Delete one you no longer use, and it stops working at once.
- A token only installs. It can't sign anyone in to your account.
Put it in .env.local
In the root of your project, add the token to .env.local:
UPFORK_TOKEN=upf_...Keep it out of Git: anyone with your token can install what you bought.
Add UpFork to components.json
Add UpFork's registry to your project's components.json, beside what's already there:
{
"registries": {
"@upfork": {
"url": "https://upfork.dev/r/{name}.json",
"headers": {
"Authorization": "Bearer ${UPFORK_TOKEN}"
}
}
}
}The CLI fills in ${UPFORK_TOKEN} from your environment when it asks UpFork for a product.
Install
npx shadcn@latest add @upfork/<name>Every product page shows its own command, ready to copy. Free products install this way too, once the
project is set up. The CLI won't run a @upfork install while UPFORK_TOKEN isn't set, whatever the product:
without a token, install a free one by its address, as above.
The CLI writes the product's files where shadcn puts them (components/, lib/, hooks/), installs the npm packages
and shadcn/ui components it needs, and adds any styles it brings to your global stylesheet.
Once UpFork is in your components.json, npx shadcn@latest search @upfork lists what's in its registry from
the command line. Looking needs no token.
Tailwind CSS 4 and 3
UpFork's components are written for Tailwind CSS 4: each time its developer saves one, UpFork installs it with the
real shadcn CLI into a Tailwind CSS 4 project to check it. A component with styles of its own also brings them as Tailwind CSS 3 settings, which the CLI
writes into a Tailwind CSS 3 project's tailwind.config.
What doesn't install with the CLI
- Plain HTML, CSS and JS: some landing pages and components are a page with its stylesheets and scripts, not a React component. Download them, or copy their code, from their page.
- Mobile components are React Native code for Expo apps, not shadcn items: they go into your Expo app from their
ZIP or an AI assistant, with their packages installed by
npx expo install. See Install mobile components. - Full-stack projects are downloads: see Templates and downloads.
When the CLI refuses an install, it prints why and what to do. CLI messages lists them all.