@useplanes/cli
v0.1.1
Published
One-command setup for installing Planes Pro components through the shadcn registry.
Readme
@useplanes/cli
One-command setup for installing Planes Pro components through the shadcn registry.
Planes is a registry of animated React components built with Motion and Tailwind: AI chat and agent UI, carousels, controls, WebGL backdrops, and more. Browse the full catalog at useplanes.com/components.
Free Planes components install directly from a URL and need no setup:
npx shadcn add https://useplanes.com/r/segmented-control.jsonPro components are served from an authenticated registry, which normally means hand-editing components.json and setting an environment variable. This CLI does both for you.
Usage
From the root of your project (it must already have a components.json — run npx shadcn@latest init first if not):
npx @useplanes/cli initYou'll be prompted for the license key from your purchase email (or pass --key). That's it — now install any Pro component the normal way:
npx shadcn add @useplanes/reaction-arcFor example, Reaction Arc, the Command Palette, or the Odometer.
What init does
- Adds the
@useplanesregistry to yourcomponents.json:{ "registries": { "@useplanes": { "url": "https://useplanes.com/api/registry/{name}", "headers": { "Authorization": "Bearer ${PLANES_LICENSE_KEY}" } } } } - Writes
PLANES_LICENSE_KEY=<your key>to.env.local. - Makes sure
.env.localis gitignored, so your key never gets committed. - Verifies the key against the registry (optional).
shadcn loads .env.local and expands ${PLANES_LICENSE_KEY} into the request header at shadcn add time — so components.json only ever contains the reference, never the raw key.
Options
| Flag | Description |
|------|-------------|
| --key <key> | License key. Falls back to the PLANES_LICENSE_KEY env var, then an interactive prompt. |
| --url <url> | Registry site URL. Defaults to https://useplanes.com. |
| --no-verify | Skip the post-setup license check. |
| -y, --yes | Non-interactive: fail instead of prompting for a missing key. |
Running init again is safe — it updates the registry entry and key in place without creating duplicates.
Requirements
- Node.js >= 18
- A shadcn project (
components.jsonpresent) - A Planes Pro license (see installation docs)
