@beyondwords/cli

Official CLI for BeyondWords. Add BeyondWords UI components to your project.

Usage

npx @beyondwords/cli components add <component>

Example:

npx @beyondwords/cli components add hello-world

Run without a component name to install everything:

npx @beyondwords/cli components add

Works in any JS/TS project:

• With a components.json (shadcn-enabled projects): installation is delegated to shadcn, so your aliases and styles config are respected.
• Without one: the CLI fetches the component from the registry and writes its files directly (you'll be asked where, default components/beyondwords/), and installs any npm dependencies with your detected package manager (npm/pnpm/yarn/bun).

Environment variables

| Variable | Description | Default | | -------------------------- | -------------------------------------------------------- | -------------------------- | | BEYONDWORDS_REGISTRY_URL | Base URL of the registry. | https://ui.beyondwords.io |

Registry

Registry sources live in the separate registry repository, served at https://ui.beyondwords.io (/r/<name>.json per item).

Development

npm install
npm run build         # compile to dist/
npm run dev -- --help # run from source via tsx
node bin/beyondwords  # run the built CLI

Releasing a new version

1. Update the version with npm version <version>
2. Push the changes and wait for CI to pass
3. Push the tag with git push --tags
4. Create a GitHub Release from the tag — the CD workflow publishes to npm (OIDC, no token needed)