Creative code should not arrive wearing a disguise.
Was this page helpful?
The Hyperiux Vault CLI adds creative interaction patterns directly into your project as source files. No hidden runtime. No locked component package. No motion logic living somewhere you cannot inspect.
Use it to install scroll effects, cursor systems, text animations, page transitions, WebGL scenes, navigation patterns, backgrounds, buttons, and microinteractions with local code ownership.
Small details. Big “who built this?” energy.
The CLI package is hyperiux.
Use it with npx:
npx hyperiux --helpFor most projects, you do not need to install the CLI globally. Running it with npx keeps the command fresh and avoids version drift across machines.
Initialize Vault in your project.
npx hyperiux initConnect your account. Installing any effect, free or Pro, needs a free Hyperiux account, so log in before you run add.
npx hyperiux loginList all available effects.
npx hyperiux listAdd an effect.
npx hyperiux add [effect-name]| Requirement | Supported setup |
|---|---|
| Framework | React 18+ or Next.js 14+ |
| WebGL / 3D effects | React Three Fiber 9, which needs React 19 (Next.js 15+) |
| Page transitions | Effects built on next-transition-router need the Next.js App Router |
| Styling | Tailwind CSS v3 or v4 |
| Language | TypeScript recommended, modern JavaScript supported |
| Node.js | 18.17+ (20+ recommended) |
| Package manager | npm, pnpm, yarn, or bun |
| Project structure | App Router, Pages Router, or a Vite + React setup |
Vault effects are source-first. That means the CLI writes files into your workspace instead of hiding them inside a package.
That is the point. You get the code. You own the edits.
| Command | Purpose |
|---|---|
| init | Prepares the project for Vault effects |
| add <effect> | Adds an effect to the workspace (-o/--overwrite, -y/--yes, --dry-run) |
| list | Lists all available effects, grouped by tier |
| outdated | Checks installed effects for available updates |
| versions | Lists every installed effect and its version |
| diff [effect] | Shows what changed upstream for an installed effect (all installed effects if omitted) |
| login | Connects your account to the CLI |
| logout | Disconnects your account from the CLI |
| whoami | Shows the currently connected account |
Use help when you need the shape of a command without opening the docs.
npx hyperiux --helpnpx hyperiux init --helpnpx hyperiux add --helpnpx hyperiux list --helpnpx hyperiux outdated --helpnpx hyperiux versions --helpnpx hyperiux diff --helpnpx hyperiux login --helpnpx hyperiux logout --helpnpx hyperiux whoami --help| Option | Description |
|---|---|
| -h, --help | Prints help for the CLI or a specific command |
| -V, --version | Prints the installed CLI version |
The CLI runs against the current working directory, so run it from your project root.
The CLI sends anonymous usage telemetry by default. To opt out, set HYPERIUX_TELEMETRY_DISABLED=1 or DO_NOT_TRACK=1 in your environment.
HYPERIUX_TELEMETRY_DISABLED=1 npx hyperiux add [effect-name] # or, respected by many CLIsDO_NOT_TRACK=1 npx hyperiux add [effect-name]The CLI exits with a non-zero status code when a command fails. This makes it usable inside CI checks and automated workflows.
Common failure cases include:
The CLI prints the failed step, the likely cause, and the next action where possible.
It is a flashlight. Not a priest.
Prepares your project for Vault effects.
npx hyperiux initThe init command creates or updates the local configuration used by Vault.
It sets where generated files should go and how the CLI should resolve project aliases, utilities, styles, and component paths.
Typical configuration includes:
It writes a hyperiux.json file at your project root. Pass -y, --yes to skip prompts and use defaults.
Example configuration:
{ "$schema": "https://vault.hyperiux.com/schema.json", "framework": "next", "router": "app", "tailwind": { "config": "tailwind.config.js", "css": "src/app/globals.css" }, "aliases": { "components": "@/components", "effects": "@/components/effects", "hooks": "@/hooks", "lib": "@/lib" }, "installedEffects": {}}Adjust aliases to match your project.
If your components live somewhere else, tell Vault where the floor is.
Adds an effect to your workspace.
npx hyperiux add [effect-name]You need to be logged in first (npx hyperiux login). Files land in src/components/effects/<slug>/ and import from @/components/effects/<slug>.
Options:
| Option | Description |
|---|---|
| -o, --overwrite | Replaces existing files (required to overwrite anything already on disk) |
| -y, --yes | Skips interactive prompts. Existing files are left untouched unless --overwrite is also passed |
| --dry-run | Shows the files and dependencies that would be installed, without installing |
npx hyperiux add [effect-name] --dry-runnpx hyperiux add [effect-name] --overwritenpx hyperiux add [effect-name] --yesEach effect includes a manifest. The CLI reads that manifest and adds only the files required for the selected effect.
Depending on the effect, the command adds:
The CLI also checks the effect manifest for required dependencies.
If the selected effect requires packages such as GSAP, Motion, Three.js, or React Three Fiber, the CLI installs the missing ones with your package manager. Use --dry-run to see them first.
No drive-by Three.js.
List all the available effects.
npx hyperiux listExample output:
Available Effects Free Effects Scroll circular-split-roll (gsap, lenis) rotation-slider (gsap, lucide-react) text-convergence (gsap) Cursor liquid-glass-cursor (motion) phantom-image-trail (gsap) pixelated-image-effect Text chromatic-text (gsap) typing-text ... Pro Effects Scroll cards-runway (gsap) helix-slider (@react-three/fiber, three) Cursor colorful-cursor-aura (gsap) full-screen-crosshair Webgl 3d-portfolio-slider (three, gsap, lenis) hyperiux-glitter (three, @react-three/fiber, @react-three/drei, @react-three/postprocessing) ... (effects are grouped by tier, then category - run the command yourself for the full, up-to-date list)This lists the whole library, not just what you have installed. To see the effects already in your project, use versions.
Check installed effects for available updates.
npx hyperiux outdatedCompares the version of each installed effect with the latest one in the registry.
List every installed effect and its version.
npx hyperiux versionsShow what changed upstream for an installed effect.
npx hyperiux diff [effect-name]Leave out the effect name to diff every installed effect. Use it before reinstalling with --overwrite, so local edits do not get lost.
Connect your account to the CLI.
npx hyperiux loginUse this when you need access to authenticated features or private registry resources.
Interactive login keeps tokens out of shell history.
Disconnect your account from the CLI.
npx hyperiux logoutUse this when you need to clear the local authenticated session from the current project or machine.
Show the currently connected account.
npx hyperiux whoamiThis is useful when you want to confirm which account the CLI is using before pulling private resources or making account-specific changes.
For most teams:
npx hyperiux initnpx hyperiux loginnpx hyperiux listnpx hyperiux add [effect-name]npx hyperiux outdatedThen:
That is the workflow. Install the effect. Own the files.
| Task | Command |
|---|---|
| Print help | npx hyperiux --help |
| Initialize Vault | npx hyperiux init |
| Add an effect | npx hyperiux add [effect-name] |
| Preview an install | npx hyperiux add [effect-name] --dry-run |
| List all available effects | npx hyperiux list |
| Check for updates | npx hyperiux outdated |
| List installed effects | npx hyperiux versions |
| See upstream changes | npx hyperiux diff [effect-name] |
| Login | npx hyperiux login |
| Logout | npx hyperiux logout |
| Who am I | npx hyperiux whoami |
Copy the code. Tune the motion. Ship the moment.