Skip to content
Hyperbits

CLI

The hyperbits binary ships with the npm package.

Terminal window
npx hyperbits find [query] [--tag <tag>] [--limit <n>] [--json]
npx hyperbits fetch <id-or-name> [--json]
npx hyperbits add <name> [--into compositions/] [--json]
npx hyperbits mcp

find

Section titled “find”

Search the published catalog by visual goal and tags.

Terminal window
npx hyperbits find "gradient background"
npx hyperbits find "text reveal" --tag text --limit 5
npx hyperbits find --tag particles --json

--tag is repeatable. Comma-separated values are accepted. --json prints a stable object with a results array.

fetch

Section titled “fetch”

Print one bit record, including HTML source, helper script tag, and the embed snippet.

Terminal window
npx hyperbits fetch fade-in
npx hyperbits fetch fade-in --json

The identifier can be the bit id (fade-in) or the exact display name (Fade In).

add

Section titled “add”

Write the bit HTML into a HyperFrames project and print the snippet to embed it.

Terminal window
npx hyperbits add fade-in
npx hyperbits add fade-in --into compositions/

add rewrites the local hyperbits.iife.js script src to the published IIFE URL so the file runs outside this repo.

Default destination is compositions/<id>.html. Embed with:

<div data-composition-src="compositions/fade-in.html"></div>

mcp

Section titled “mcp”

Start the hyperbits MCP server on stdio. See the MCP page.

hyperframes add

Section titled “hyperframes add”

npx hyperframes add does not take a registry URL. Point a project at this catalog by setting registry in hyperframes.json to the docs site origin (the host of /registry.json and /blocks/<name>/registry-item.json), then:

Terminal window
npx hyperframes add fade-in

hyperbits add is the guaranteed install path. The HyperFrames registry is an extra path, not a substitute.