Getting started

Requirements

• Bun 1.3.9
• Git
• A React Storybook repository for the translation workflow
• Docker with Compose only if you want to run the self-hosting baseline

Build the current source

The repository's only Git tag/GitHub Release is v0.1.0, whose snapshot already contains a CLI 0.2.0 manifest. npm separately serves an older @compify/cli@0.1.0 artifact from different source history; it is not the package produced by that tag. The current CLI 0.3.0 and matching @compify/storybook@0.2.0 manifests are AGPL source candidates. Build this checkout until publication is explicitly announced. The project-operated default API is available as a public alpha and includes the current Storybook publish route, but it is not a generally available managed service or SLA; self-hosted operators remain responsible for their deployments.

git clone https://github.com/kubet/compify.git
cd compify/packages/cli
bun install --frozen-lockfile
bun run build
bun link
compify --help

Verify the golden path

The repository includes a source-only CSF3 fixture, so you can verify inspection and export before trying a real design-system repository. From the repository root after the build above:

bun packages/cli/dist/index.js storybook inspect \
  src/Button.stories.tsx --cwd examples/storybook-button
bun packages/cli/dist/index.js storybook export \
  src/Button.stories.tsx --story Primary \
  --cwd examples/storybook-button \
  --output .compify/button.registry.json

The inspection should report Button.tsx, button.module.css, Primary and Disabled, and no portability issues. React is a consumer peer rather than an artifact runtime dependency because the source uses the automatic JSX transform. The export selects only the Primary story metadata while retaining the component source graph. Open and review the generated JSON; artifact generation is not proof that the result is visually or behaviorally equivalent in a consumer app.

Inspect before translating

From a React Storybook project:

compify storybook inspect src/components/Button.stories.tsx
compify storybook export src/components/Button.stories.tsx \
  --story Primary \
  --output .compify/button.registry-item.json

Inspection is static: it parses source without importing or executing the story module. Support is intentionally constrained; read Storybook translation before relying on it in automation.

Choose the next step