Loading
Loading
Loading
mobile footer

Build the Interaction Layer Your Website is Missing.

Browse All EffectsBrowse All EffectsBrowse All EffectsUpgrade to ProUpgrade to ProUpgrade to Pro

70+ effects free, forever. No credit card.

© 2026 Hyperiux. All Rights Reserved.

AI Component CatalogueHey AI, Learn About Us
Platform

Vault

  • Documentation
  • Pricing
  • Blog
  • Community
  • NPM
  • MCP

Categories

  • All Effects
  • WebGL
  • Text
  • Backgrounds
  • Buttons
  • Carousels
  • Scroll
  • Components
  • Navigation
  • Cursor
  • Transitions
  • Loaders

Documents

  • Introduction
  • Installation
  • CLI
  • Dependencies
  • License

Legal

  • License Agreement
  • Terms of Service
  • Privacy Policy
  • Refund Policy
Socials
  • Twitter / X
  • LinkedIn
  • GitHub
  • Instagram
Contact Us
  • hello@hyperiux.com
New effects, in your inbox

Every new drop, plus the occasional behind-the-scenes build. No spam. Unsubscribe anytime.

All Effects
Featured ComponentsText AnimationsAnimated BackgroundsAnimated ButtonsCarousel EffectsScroll EffectsCreative ComponentsNavigationsCursor EffectsTransitionsLoadersWebGL & 3D Effects
Templates
IntroductionInstallationCLIDependenciesLicense
PricingBlogGithubNPMMCP Doc
Home/docs/cli

Vault CLI

Creative code should not arrive wearing a disguise.

Was this page helpful?

PreviousInstallationNextMCP

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.

CLI Package

The CLI package is hyperiux.

Use it with npx:

TSX
1npx hyperiux --help

For 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.

Quick Start

Initialize Vault in your project.

TSX
1npx hyperiux init

Connect your account. Installing any effect, free or Pro, needs a free Hyperiux account, so log in before you run add.

TSX
1npx hyperiux login

List all available effects.

TSX
1npx hyperiux list

Add an effect.

TSX
1npx hyperiux add [effect-name]

Requirements

RequirementSupported setup
FrameworkReact 18+ or Next.js 14+
WebGL / 3D effectsReact Three Fiber 9, which needs React 19 (Next.js 15+)
Page transitionsEffects built on next-transition-router need the Next.js App Router
StylingTailwind CSS v3 or v4
LanguageTypeScript recommended, modern JavaScript supported
Node.js18.17+ (20+ recommended)
Package managernpm, pnpm, yarn, or bun
Project structureApp 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 Reference

CommandPurpose
initPrepares the project for Vault effects
add <effect>Adds an effect to the workspace (-o/--overwrite, -y/--yes, --dry-run)
listLists all available effects, grouped by tier
outdatedChecks installed effects for available updates
versionsLists every installed effect and its version
diff [effect]Shows what changed upstream for an installed effect (all installed effects if omitted)
loginConnects your account to the CLI
logoutDisconnects your account from the CLI
whoamiShows the currently connected account

Help Commands

Use help when you need the shape of a command without opening the docs.

TSX
1npx hyperiux --help2npx hyperiux init --help3npx hyperiux add --help4npx hyperiux list --help5npx hyperiux outdated --help6npx hyperiux versions --help7npx hyperiux diff --help8npx hyperiux login --help9npx hyperiux logout --help10npx hyperiux whoami --help

Global Options

OptionDescription
-h, --helpPrints help for the CLI or a specific command
-V, --versionPrints the installed CLI version

The CLI runs against the current working directory, so run it from your project root.

Telemetry

The CLI sends anonymous usage telemetry by default. To opt out, set HYPERIUX_TELEMETRY_DISABLED=1 or DO_NOT_TRACK=1 in your environment.

TSX
1HYPERIUX_TELEMETRY_DISABLED=1 npx hyperiux add [effect-name]2 3# or, respected by many CLIs4DO_NOT_TRACK=1 npx hyperiux add [effect-name]

Exit Behavior

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:

  • invalid effect name
  • missing package manager
  • registry request failure
  • not logged in, or missing Pro access
  • daily install limit reached
  • dependency installation failure
  • unsupported project structure
  • file conflict during install
  • missing write permission in the target directory

The CLI prints the failed step, the likely cause, and the next action where possible.

It is a flashlight. Not a priest.

init

Prepares your project for Vault effects.

TSX
1npx hyperiux init

The 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:

  • effect output alias
  • component, hook and lib aliases
  • Tailwind CSS config and entry path
  • project framework detection
  • Next.js router detection
  • installed effects

It writes a hyperiux.json file at your project root. Pass -y, --yes to skip prompts and use defaults.

Example configuration:

JSON
1{2  "$schema": "https://vault.hyperiux.com/schema.json",3  "framework": "next",4  "router": "app",5  "tailwind": {6    "config": "tailwind.config.js",7    "css": "src/app/globals.css"8  },9  "aliases": {10    "components": "@/components",11    "effects": "@/components/effects",12    "hooks": "@/hooks",13    "lib": "@/lib"14  },15  "installedEffects": {}16}

Adjust aliases to match your project.

If your components live somewhere else, tell Vault where the floor is.

add

Adds an effect to your workspace.

TSX
1npx 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:

OptionDescription
-o, --overwriteReplaces existing files (required to overwrite anything already on disk)
-y, --yesSkips interactive prompts. Existing files are left untouched unless --overwrite is also passed
--dry-runShows the files and dependencies that would be installed, without installing
TSX
1npx hyperiux add [effect-name] --dry-run2npx hyperiux add [effect-name] --overwrite3npx hyperiux add [effect-name] --yes

Each 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:

  • React components
  • hooks
  • utility files
  • styles
  • shaders
  • animation setup
  • dependency notes
  • usage examples

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

List all the available effects.

TSX
1npx hyperiux list

Example output:

Text
1Available Effects2 3Free Effects4 5Scroll6 7  circular-split-roll (gsap, lenis)8  rotation-slider (gsap, lucide-react)9  text-convergence (gsap)10 11Cursor12 13  liquid-glass-cursor (motion)14  phantom-image-trail (gsap)15  pixelated-image-effect16 17Text18 19  chromatic-text (gsap)20  typing-text21 22...23 24Pro Effects25 26Scroll27 28  cards-runway (gsap)29  helix-slider (@react-three/fiber, three)30 31Cursor32 33  colorful-cursor-aura (gsap)34  full-screen-crosshair35 36Webgl37 38  3d-portfolio-slider (three, gsap, lenis)39  hyperiux-glitter (three, @react-three/fiber, @react-three/drei, @react-three/postprocessing)40 41... (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.

outdated

Check installed effects for available updates.

TSX
1npx hyperiux outdated

Compares the version of each installed effect with the latest one in the registry.

versions

List every installed effect and its version.

TSX
1npx hyperiux versions

diff

Show what changed upstream for an installed effect.

TSX
1npx 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.

login

Connect your account to the CLI.

TSX
1npx hyperiux login

Use this when you need access to authenticated features or private registry resources.

Interactive login keeps tokens out of shell history.

logout

Disconnect your account from the CLI.

TSX
1npx hyperiux logout

Use this when you need to clear the local authenticated session from the current project or machine.

whoami

Show the currently connected account.

TSX
1npx hyperiux whoami

This is useful when you want to confirm which account the CLI is using before pulling private resources or making account-specific changes.

Recommended Workflow

For most teams:

TSX
1npx hyperiux init2npx hyperiux login3npx hyperiux list4npx hyperiux add [effect-name]5npx hyperiux outdated

Then:

  • Inspect the generated files.
  • Read the implementation notes.
  • Tune the effect.
  • Test mobile behavior.
  • Check reduced motion.
  • Profile performance.
  • Review accessibility.
  • Commit the source.

That is the workflow. Install the effect. Own the files.

Command Summary

TaskCommand
Print helpnpx hyperiux --help
Initialize Vaultnpx hyperiux init
Add an effectnpx hyperiux add [effect-name]
Preview an installnpx hyperiux add [effect-name] --dry-run
List all available effectsnpx hyperiux list
Check for updatesnpx hyperiux outdated
List installed effectsnpx hyperiux versions
See upstream changesnpx hyperiux diff [effect-name]
Loginnpx hyperiux login
Logoutnpx hyperiux logout
Who am Inpx hyperiux whoami

Copy the code. Tune the motion. Ship the moment.