Getting started
Installation
The brandionary command adds theme files. It looks upward from the working directory until it finds config/settings_schema.json and layout/theme.liquid.
npx brandionary add <component>What the command does
- Resolves the component, including any registry dependencies, from ui.brandionary.com.
- Prints every file it would create, leave unchanged, or replace.
- Writes new files. An existing file with the same contents is skipped.
- Stops when an existing file differs, unless you accept the prompt or pass
--overwrite.--yesskips the prompt and still keeps the existing file. --dry-runprints the plan and writes nothing.- Prints manual steps, such as adding the section in the theme editor.
Theme paths
sections/bnry-*.liquidsnippets/bnry-*.liquidblocks/bnry-*.liquidassets/bnry-*.cssandassets/bnry-*.js
The prefix keeps these files apart from theme files such as Dawn's cart-drawer.liquid. Translation strings live in the section schema. The installer does not write locales/.
Flags
| Flag | Effect |
|---|---|
--cwd | Theme directory to search from. |
--dry-run | Show the file plan without writing. |
--overwrite | Replace conflicting files. |
--yes | Skip the prompt. Conflicts still block the install. |
--registry | Built registry URL or a local directory of JSON files. |
Author commands
From this repository, the same executable validates and builds the source registry.
npx brandionary registry validate
npx brandionary registry build --out apps/docs/public/r