Sorb™ documentation
Sorb is the design-token bridge for the running app. Propose a token change in Figma, watch your real components re-skin live, then verify it before you merge. Start with Getting started if you have a React app and Node 20; use the package reference when you need every export, route, and flag.
Start here
Concepts
Tokens & taxonomy
DTCG format, the three tiers, references, and the resolved map the bridge serves.
How previews work
From POST /preview to the banner: polling, the vocabulary guard, error outcomes.
The bridge (sorb dev)
What sorb dev does, its routes, and the handshake and check commands.
Hosted vs local
What runs where, what leaves your machine, and which key does what.
Packages (reference)
@sorb/core
The shared contract: tiers, resolved tokens, role ids, connector registry.
@sorb/seed
Style Dictionary formats, the resolve/capture/adapt CLI, and the adapt library.
@sorb/leaf
Every export of the React SDK: provider, hooks, banner, sorbInit, dark mode, adapters.
@sorb/juice
The sorb CLI commands, the bridge HTTP routes, and the library exports.
React SDK guide
Wrap your app in SorbProvider; tokens arrive as CSS custom properties, live-swappable.
Figma plugin
The Sorb plugin (Canopy)
Sign in, pair with your project, and run the propose → preview → verify loop.
Install (beta)
Download the zip and import it into Figma desktop as a development plugin — the plugin isn't on the Figma Community yet.
User guide overview
Screen-by-screen walkthrough of the plugin.
Tokens view
Edit, preview, and save tokens.
Components view
Insert captured components into Figma.
Settings view
Bridge, app URL, keys, and advanced setup.
Connect flows
Sign in first; org key, handshake, and local bridge under Advanced.
Cloud
Accounts, orgs & keys
Create an account and org, invite members, and issue publishable and secret keys.
REST API
The customer-facing app.sorbcloud.com routes with their auth model.
Tokenize a repo
Scan a codebase for hardcoded values and open an additive tokens PR.
Token version → GitHub PR
Turn a published token version into a pull request.
Help
Beta status
Sorb is in free beta. It is not generally available yet — expect rough edges and active iteration. During the beta the local loop (sorb dev + @sorb/leaf) runs entirely on your machine with no account required; a hosted account adds the cloud bridge and org connection.
Verified = checked against your live components’ tier/type bindings before merge — not a visual or accessibility audit.
Works with Figma. Not affiliated with, or endorsed by, Figma. Figma is a trademark of Figma, Inc.