@usefragments/cli
v1.0.0
Published
CLI and dev tools for Fragments design system
Maintainers
Readme
@usefragments/cli
Source-available. This package is distributed publicly on npm under FSL-1.1-MIT; source stays private. Contribute by filing an issue at https://github.com/fragments-sdk/fragments/issues.
CLI and dev tools for Fragments design-system governance.
Install
npm install @usefragments/cliUsage
fragments build
fragments validate
fragments context install --cloud
fragments status
fragments --helpRegistry Source Install
Governed UI installs should come from a Fragments registry artifact. This writes
source into the app plus .fragments/registry-lock.json, which lets governance
prove that the committed source matches the published registry version.
export FRAGMENTS_API_KEY="fc_..."
fragments registry add --all \
--to src/fragments/ui \
--import-path "@/fragments/ui"
fragments registry status
fragments registry diff
fragments registry sync
fragments registry migrate --dry-runThe CLI discovers the hosted artifact endpoint from Fragments Cloud catalog
metadata when FRAGMENTS_API_KEY or --api-key is present. Use
--registry-from, --from, or FRAGMENTS_UI_REGISTRY_ARTIFACT_URL only when
installing from a local artifact or overriding the Cloud-discovered source.
Run fragments registry migrate to convert an existing @usefragments/ui
app to source install: it installs the registry source, rewrites npm imports,
updates simple Next.js transpilePackages config, and removes the npm UI
package from package.json unless --keep-package is passed.
Use fragments create --ui npm or fragments setup --ui npm for the legacy
npm fallback while it remains supported.
MCP
Fragments MCP is hosted by Fragments Cloud:
https://app.usefragments.com/api/mcpInteractive RC clients can use MCP OAuth discovery. Headless or CI clients can use a Fragments Cloud API key in the HTTP authorization header:
Authorization: Bearer <FRAGMENTS_API_KEY>fragments mcp now prints hosted setup information. The old local stdio server
and @usefragments/cli/mcp programmatic export are removed.
License
FSL-1.1-MIT
