Compify documentation

Storybook stays the upstream authoring, test, and documentation environment. Compify provides a deliberately narrower path from supported React CSF source to reviewable shadcn registry artifacts. Existing editor, registry, CLI, MCP, and self-hosting workflows remain available within the boundaries below.

Release and service status

The repository's sole Git tag/GitHub Release is v0.1.0, but that source snapshot already contains a CLI manifest numbered 0.2.0. npm independently serves an older @compify/cli@0.1.0 artifact from different source history; the tag and npm package are not one release. The current CLI 0.3.0 and @compify/storybook@0.2.0 manifests identify AGPL source candidates; neither current candidate has been published. The default https://api.compify.app deployment currently exposes the current-source POST /cli/publish-story contract as a public alpha. That operational endpoint is not a generally available managed service or SLA. A self-hosted deployment is operated, secured, upgraded, and recovered by its own operator.

Storybook translation

Inspect supported CSF, export an artifact, and publish an explicit selection.

Get started

Build the CLI and choose a local workflow.

Registry

Install published artifacts with shadcn-compatible tooling.

Self-host

Run the included local or single-server Compose baseline.

Source-to-distribution workflow

Author and verify in Storybook

Keep component implementation, stories, tests, and documentation in the source repository. Compify does not replace these Storybook responsibilities.

Inspect and select

Use static inspection on a supported React CSF file. Resolve unsupported input before exporting, and specify one story file when a project contains several.

Export and review

Generate a local shadcn registry item. Review its source, dependencies, name, and metadata just as you would any other build artifact.

Publish or install

An authenticated publish can send the selected translation to a configured Compify API. Consumers can install available items through registry or Compify CLI tooling.

Two complementary MCP paths

The official Storybook MCP supplies agents with upstream Storybook context; its MCP/manifests surface is currently preview/unstable and React-only. Compify MCP supplies registry search and artifact context. Neither is required for static Storybook translation, and Compify does not proxy the official server.