@venator-ui/cli
v0.3.1
Published
CLI for deploying Venator archetypes and patterns
Readme
@venator-ui/cli
CLI for deploying full application architectures, composing your UI system, and generating AI context manifests.
Scaffold a complete app or add individual patterns in seconds.
Usage
# Deploy a complete application architecture
npx @venator-ui/cli init dashboard
npx @venator-ui/cli init admin
npx @venator-ui/cli init ai-tool
# Add a single pattern to an existing project
npx @venator-ui/cli add dashboard-layout
npx @venator-ui/cli add page-header
npx @venator-ui/cli add sidebar-nav
npx @venator-ui/cli add topbar
npx @venator-ui/cli add stat-card
npx @venator-ui/cli add module-gridThemes
Deploy an archetype with a specific theme using the --theme flag:
npx @venator-ui/cli init dashboard --theme slate
npx @venator-ui/cli init dashboard --theme obsidian-lightAvailable themes:
| Theme | Description |
|---|---|
| obsidian | Obsidian Dark (default, no attribute injected) |
| obsidian-light | Obsidian Light |
| slate | Slate Dark |
| slate-light | Slate Light |
If --theme is omitted, the archetype deploys with Obsidian Dark.
AI context manifest
Generate a context file that teaches AI coding tools how to use Venator. The command introspects the Venator version installed in your project (design tokens, components, props, themes) and writes the result as a markdown manifest.
npx @venator-ui/cli manifest --target claude # CLAUDE.md
npx @venator-ui/cli manifest --target cursor # .cursorrules
npx @venator-ui/cli manifest --target agents # AGENTS.md
# No target writes a neutral venator.md
npx @venator-ui/cli manifest| Flag | Description |
|---|---|
| --target | Output convention: claude, cursor, or agents |
| --force | Overwrite the output file if it already exists |
With the manifest in place, copilots generate Venator-aligned components without scanning the whole library.
After deploying an archetype
cd my-app
npm install
npm run devYour project is now ready to run locally.
