Vault CLI

Creative code should not arrive wearing a disguise.

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:

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

npx hyperiux init

Add an effect.

npx hyperiux add [effect-name]

List what is installed.

npx hyperiux list

Connect your account.

npx hyperiux login

Then verify your identity and continue with the effect you need.

Requirements

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

Help Commands

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

npx hyperiux --help
npx hyperiux add --help
npx hyperiux list --help
npx hyperiux login --help
npx hyperiux logout --help
npx hyperiux whoami --help

Global Options

Use --verbose when reporting issues or debugging registry, dependency, or file-generation problems.

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
• missing Pro authentication
• dependency installation failure
• unsupported project structure
• file conflict during install or upgrade
• 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.

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

• component output path
• utility alias
• Tailwind CSS entry path
• package manager detection
• registry configuration
• project framework detection

Example configuration:

{
  "style": "default",
  "tailwind": {
    "config": "tailwind.config.js",
    "css": "app/globals.css",
    "baseColor": "slate",
    "cssVariables": true
  },
  "aliases": {
    "components": "@/components",
    "utils": "@/lib/utils"
  },
  "registries": {
    "@hyperiux": "https://vault.hyperiux.com/r/{name}.json"
  }
}

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.

npx hyperiux add [effect-name]

Example:

npx hyperiux add [effect-name]

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 makes those requirements visible during installation.

No drive-by Three.js.

list

List the effects installed in the project.

npx hyperiux list

Example output:

Installed Vault effects

phantom-image-trail
  version: 1.0.0
  path: components/hyperiux/phantom-image-trail/index.jsx
  dependencies: gsap

Use this when you want to confirm what the CLI has already added.

login

Connect your account to the CLI.

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

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

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

npx hyperiux init
npx hyperiux add [effect-name]
npx hyperiux list
npx hyperiux login
npx hyperiux whoami

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

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