Init
Initialize config and tokens.json starting with an Open Source design system.
npx tz init
Supported design systems:
- Adobe Spectrum
- Apple Human Interface Guidelines
- GitHub Primer
- IBM Carbon
- Figma Simple Design System
- Salesforce Lightning
- Shopify Polaris
- Radix
Have another one to add? Suggest it!
Build
Generate code from tokens.json based on plugins. Requires a config file.
npx tz build
Build Flags
| Name | Description |
|---|---|
--watch | -w | Rebuild whenever any token changes are detected. |
--no-lint | Ignore any lint errors while building. |
Check
Validate all DTCG tokens for syntax errors, and run any linters you’ve enabled. Can optionally specify a [path] tokens are located at (by default, will look for the tokens defined in your config file).
npx tz check [filename]
Normalize
The DTCG format has gone through many iterations over the years. Terrazzo lenient in the inputs it allows, such as allowing legacy sRGB hex colors without throwing a parsing error. To quickly update your tokens to the latest version of the format, run the following command:
tz normalize tokens.json -o normalized.json
This will keep your tokens 100% as-authored, but will upgrade older DTCG files to the updated format and will safely fix minor issues. But just as a safety precaution, it requires saving to a new location just so you can review the changes before committing them.
| Name | Description |
|---|---|
--out | -o | Tokens file to output. |
Global Flags
Flags available for any command
| Name | Description |
|---|---|
--config | -c | Path to config (default: terrazzo.config.js). |
--silent | Suppress warnings. |
--help | Show help message and exit. |
--version | Show version and exit. |