AI agent guide | Hyper Flow

Hyper Flow ships a reusable skill at skills/hyper-flow/. Install it with the skills CLI when a coding agent needs to add, tune, debug, or review animation.

Install the skill

Run the official skills.sh command from your project:

npx skills add scorpion7slayer/hyper-flow

The repository exposes one installable skill named hyper-flow. To select it explicitly or install it globally, use:

npx skills add scorpion7slayer/hyper-flow --skill hyper-flow
npx skills add scorpion7slayer/hyper-flow --skill hyper-flow --global

The CLI detects supported agents such as Codex, Claude Code and Cursor and configures the selected scope. Once installed, invoke the skill explicitly:

Use $hyper-flow to create a fine interactive particle field for this loading state.

The skill tells the agent to:

inspect the installed package version before writing code;
choose createParticleFlow() for Canvas particles and flow() for DOM motion;
prefer fine points and high density over large retro pixel blocks;
choose among ten configurable shapes before writing a custom renderer;
use viewport padding and clipping when a field must stay inside a component;
prefer field mixing and transform pipelines before duplicating field math;
use trails, blend modes, connections, origin, scale and pointer forces when they express the intended system;
use a custom field, transform, or renderer when built-in options are not enough;
animate transform, opacity, and filter instead of layout properties;
keep reduced-motion behavior enabled;
reuse createFlow() for project-wide defaults;
verify focus, replay, interruption, and cleanup behavior.

Agent-readable docs

Nimbus emits these surfaces during the static build:

/llms.txt for the page index;
/llms-full.txt for the complete documentation corpus;
/<page>/index.md for clean Markdown;
/<page>/index.mdx for authored source.

Each documentation page also advertises its Markdown alternate in the document head. Agents can consume the API reference without scraping page chrome.

Short context block

When a tool cannot load the skill, provide this minimal contract:

Hyper Flow exports createParticleFlow, mixParticleFields,
composeParticleTransforms, particleTransforms, particleFields,
particlePresets, flow, createFlow, timeline, stagger and inView. Use
createParticleFlow for Canvas points and flow for DOM motion. It includes
eighteen fields, ten shapes, viewport clipping, transform pipelines,
connections, trails and pointer forces. Keep points fine, call destroy on
unmount, respect reduced motion, and do not add a second animation runtime.