| title | Installation |
|---|---|
| description | Install SayKit and its supporting packages |
SayKit is split into a small core runtime and a set of optional packages for configuration, formatters, transformers, and framework integrations. Pick the pieces you need.
Every SayKit project needs the same set of pieces:
| Package | Why |
|---|---|
saykit |
The core runtime: catalogues, views, stores and formatting |
@saykit/config |
The config schema (defineConfig) and the saykit CLI |
| One formatter | Reads and writes your translation files (e.g. @saykit/format-po) |
| One or more transformers | Extracts and rewrites macros from your source files |
| One build-tool plugin | Wires the transformer into your bundler |
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
For a React + Vite project, including TanStack Start (or any other unplugin-compatible bundler):
<Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>
pnpm add saykit @saykit/react
pnpm add -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx unplugin-saykitnpm install saykit @saykit/react
npm install -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx unplugin-saykityarn add saykit @saykit/react
yarn add -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx unplugin-saykitbun add saykit @saykit/react
bun add -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx unplugin-saykitFor a Next.js, React Native, Expo, or other Babel-driven project:
<Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>
pnpm add saykit @saykit/react
pnpm add -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx babel-plugin-saykitnpm install saykit @saykit/react
npm install -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx babel-plugin-saykityarn add saykit @saykit/react
yarn add -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx babel-plugin-saykitbun add saykit @saykit/react
bun add -D @saykit/config @saykit/format-po @saykit/transform-js @saykit/transform-jsx babel-plugin-saykitFor a Carbon Discord bot (with tsdown + Cloudflare Workers):
<Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>
pnpm add saykit @saykit/carbon
pnpm add -D @saykit/config @saykit/format-po @saykit/transform-js unplugin-saykitnpm install saykit @saykit/carbon
npm install -D @saykit/config @saykit/format-po @saykit/transform-js unplugin-saykityarn add saykit @saykit/carbon
yarn add -D @saykit/config @saykit/format-po @saykit/transform-js unplugin-saykitbun add saykit @saykit/carbon
bun add -D @saykit/config @saykit/format-po @saykit/transform-js unplugin-saykitimport { Boxes, Cog, Atom, Bot, Hammer, FileType2 } from 'lucide-react';
<Card icon={} title="saykit" href="/reference/api/saykit">
The core runtime: createCatalogue, createStore, the say macros and formatting. Every SayKit
app depends on it.
<Card icon={} title="@saykit/config" href="/reference/api/config">
The config schema, the saykit CLI, and shared building blocks used by plugins and custom
transformers.
<Card icon={} title="@saykit/react" href="/integrations/react">
React integration. <Say>, SayProvider, useSay, withSay.
<Card icon={} title="@saykit/carbon" href="/integrations/carbon">
Carbon Discord-bot integration. SayPlugin, withSay, locale-aware
interaction.say.
<Card icon={} title="unplugin-saykit" href="/integrations/vite"> Universal bundler plugin: Vite, Rollup, Rolldown, Webpack, Rspack, esbuild, Farm, Bun.
<Card icon={} title="babel-plugin-saykit" href="/integrations/babel"> Babel plugin. Use this for Next.js, React Native, Expo, or any Babel-driven pipeline.
<Card icon={} title="@saykit/format-po"> Gettext PO formatter, the default for SayKit examples.
<Card icon={} title="@saykit/transform-js / -jsx">
The macro transformers for .js/.ts and .jsx/.tsx. Used by the build-tool plugins.
A few packages have peer requirements worth knowing about:
@saykit/reactpeersreactandsaykit. The package uses thereact-serverexport condition for server rendering, so React 18+ is required and React 19+ is recommended.@saykit/carbonpeers@buape/carbonandsaykit.babel-plugin-saykitexpects@babel/core(you almost certainly already have it).
If this is your first SayKit project, the quickstart walks through the whole loop (config, source, extraction, and runtime) in a few minutes.