Skip to main content
Join the waitlist

CLI

Optional source installation and project tools from @usefragments/cli.

Start with a working React app and run commands from its root. For normal component use, install @usefragments/ui through your package manager. Fragments desktop has its own setup guide.

Copy component source

Choose copied source when you need the component files in your own repository. Preview the writes, then add the components you want:

npx @usefragments/cli add button card --dry-run
npx @usefragments/cli add button card

The public registry needs no account or key. The command writes selected source and its dependencies, a stylesheet and a registry lockfile, then prints the packages to install. Follow the source installation guide for import paths and styles.

Review source updates

Registry commands
Command
Purpose
registry statusInspect the lockfile and installed source state.
registry diffCompare your installed source with the registry.
registry sync --dry-runPreview an update to the existing selection.
registry syncApply the update using the lockfile’s component selection.
npx @usefragments/cli registry status
npx @usefragments/cli registry diff
npx @usefragments/cli registry sync --dry-run

Review the proposed changes before running npx @usefragments/cli registry sync. Resolve any reported conflicts and inspect the resulting source diff before committing.

Set up local agent tooling

To configure the published CLI’s project metadata and available agent integrations, run:

npx @usefragments/cli@latest init --install --metadata-only --no-ci
npx @usefragments/cli doctor

Review generated files and follow any action-required output. --metadata-only keeps the app’s runtime setup in place; --no-ci leaves CI configuration untouched. Doctor reports configuration and observed agent delivery separately. Continue with local MCP verification.

Look up a command

Use the installed CLI’s help for arguments and defaults:

npx @usefragments/cli --help
npx @usefragments/cli add --help
npx @usefragments/cli registry sync --help

For a diagnostic code printed by the CLI, read its metadata from your installed package:

npx @usefragments/cli explain FUI2001 --print

Replace FUI2001 with the reported code. The command prints its title, rule, category, default severity, fix availability and suppression guidance. Unknown codes return an error; use the CLI version that produced the finding. These are package diagnostics, not a mapping to desktop Checks. Older releases may print a retired docs link; the local metadata still works. The public CLI 3.3.4 supports this command.

Next steps