Installation
Initialize supported frameworks with one CLI command.
Initialize project
Start with a React and TypeScript project. Run bunx @yopem-ui/cli init from
its root:
Init detects Vite React, React Router (client or framework), TanStack Router,
TanStack Start, Next.js App Router, or Astro. It installs the shared source,
StyleX dependencies, and Oxlint plugin; configures the @/* alias, build
plugins, and root styles. Existing project code stays in place. Unsupported or
conflicting configuration stops with an error instead of being overwritten.
If your project has multiple supported frameworks, use --framework as shown
above. Accepted values: vite, react-router, tanstack-router,
tanstack-start, next, and astro. React Router client mode is detected from
react-router or react-router-dom; framework mode from @react-router/dev.
Vite integrations use Rolldown Babel. Next.js App Router requires Node 24+ and
webpack. React Router RSC mode, Next.js Pages Router, and other build tools are
not supported by init. Until registry deployment, CLI reads registry files from
http://localhost:3100/r; start docs server with bun run dev before using it.
CLI and Oxlint plugin are not published yet; bunx commands work after both
packages are released.
Verify and continue
Run your project's production build. It must finish without StyleX or CSS
extraction errors. Run bunx oxlint . to check your app; see
lint rules for configuration.
Then add your first component with the CLI. To refresh
installed shared files, run bunx @yopem-ui/cli update base; locally edited
files are preserved unless you pass --force.
Static light mode needs no provider. Add switching only if needed. See the theming guide for dark mode, custom themes, and CSP nonces.