Browse or search the Hyperiux Vault catalog of React/Next.js interaction effects (scroll systems, cursor trails, WebGL scenes, animated buttons, page transitions, etc).

Each result includes tier ("free" or "pro") - use this to answer "how many free/pro effects are there" or "which of these are free" directly from one call, by filtering/counting the returned list yourself. Don't estimate or guess these counts, and don't call hyperiux_get_effect per-item just to total them up - it's unnecessary here. hyperiux_get_effect is still the right call for one specific effect's full description/props/changelog.

Args:

• query (string, optional): substring match against effect name

• category (string, optional): filter to one category slug

• limit (number, default 30, max 100)

• offset (number, default 0)

Returns JSON: { total, count, offset, effects: [{ name, category, categories, dependencies, version, tier }], has_more, next_offset? }

Examples:

• "What cursor effects are available?" -> category="cursor"

• "Is there anything with 'particles' in the name?" -> query="particles"

• "How many free effects are there?" -> call with a limit high enough to cover total (check total/has_more first), then count tier === "free" yourself.

• Don't use when: you need one effect's full description/props/changelog - use hyperiux_get_effect instead.

Get full details for one Hyperiux Vault effect by its exact slug - description, tier (free/pro), npm dependencies, version, changelog, and install instructions. Optionally includes full source code.

Args:

• name (string): exact effect slug

• include_source (boolean, default false): also return component source. Needs a signed-in account for every effect (see below) and counts as one of the day's installs; details-only lookups (false) don't.

Returns JSON: { name, title, description, tier, version, dependencies, changelog, install_command, preview_url, import_path, target, main, import_statement, files: [{ path, content? }] }

• changelog: array of { version, date, summary, breaking }, newest first

• files[].content is omitted unless include_source=true AND the caller is signed in (and on Pro, for a Pro effect)

• import_statement is the exact import line to use after installing (e.g. import DottedGrid from "@/components/effects/dotted-grid";), built from exportKind/exportName/import_path the same way the CLI's own hyperiux add output does - omitted if the registry entry has no import_path

• install_limit/install_remaining: present on a normal (non-rate-limited) lookup, telling you how many more distinct effects this identity can fetch today - mention this to the user when remaining is low, same as the website's copy toast and the CLI's own "N of M daily installs left" line

No token (or an invalid one) with include_source=true: the response still includes metadata, but files have no content and sign_in_required/sign_in_required_reason tell the user to run npx hyperiux login - every install needs a free account. Don't retry; ask the user to sign in.

Pro effects without a Pro subscription: metadata only, and source_locked explains the effect needs Hyperiux Pro - expected, not an error.

Free effects past the caller's daily install cap: the response still includes metadata but files have no content, and rate_limited/rate_limit_reason explain the daily limit and when to retry - also not an error, it's expected once the cap is hit.

Examples:

• "What does the dotted-grid effect need?" -> name="dotted-grid" (dependencies field)

• "Show me the code for dotted-grid" -> name="dotted-grid", include_source=true

• Don't use when: you don't have an exact slug yet - use hyperiux_list_effects first.

Error Handling:

• Returns "Effect '' not found" if the slug doesn't exist - check hyperiux_list_effects for the correct spelling.

List every effect category in the Hyperiux Vault catalog with how many effects are in each - useful before calling hyperiux_list_effects with a category filter, to confirm the exact category slug and see relative size.

Returns JSON: { categories: [{ category, count }] }, sorted by count descending.

Examples:

• "What kinds of effects does Hyperiux have?" -> call with no args

• Don't use when: you already know the category slug and just want its effects - call hyperiux_list_effects directly.