CLI
Astro-first wrapper around shadcn for init/add, project info, docs lookup, and docs generation.
The bejamas CLI is a thin Astro-first wrapper over shadcn. Use it for:
init: scaffold Astro (single app or monorepo).add: install from registries with short names.info: show the current project and config summary from shadcn.docs: fetch docs, examples, and API links for components.docs:build: generate MDX docs from.astrocomments.docs:check: validate documentation completeness for components.
For advanced registry browsing, use the shadcn CLI (view, search, list, build).
Install
Section titled “Install”Use directly via npx:
npx bejamas@latest --helpCommands
Section titled “Commands”Create an Astro app or monorepo, wire Tailwind v4, tokens, base styles, and components.json.
You can also switch an existing app to a different preset by rerunning init --preset. Installed UI components are reconfigured to the new preset automatically; use --no-reinstall to opt out.
Starter templates are English-only by default. Use --rtl --lang <ar|fa|he> when you want the CLI to add the template i18n/RTL wiring.
npx bejamas init [--mode astro|monorepo|monorepo+docs] [--dir .] [--pm pnpm|npm|yarn] [-y]npx bejamas init --preset <encoded-preset> --yesSets up Astro project(s) + optional docs workspace (monorepo+docs)
Tailwind v4 + globals
Base tokens & CSS variables
components.json (Bejamas schema)
Compatibility note: Bejamas runs exact shadcn v4.1.1 for managed CLI commands. Bejamas still preserves its custom init behavior, including preset switching, style support, and init --base-color.
Install a component/block from configured registries (see components.json → registries). Writes files under your aliases.
npx bejamas add <name>npx bejamas add @bejamas/pricing-tablenpx bejamas add @shadcn/buttonNotes
Namespaced form @namespace/name targets a specific registry.
—dry-run shows what would be written.
Proxy to shadcn info so you can inspect the current project, installed components, and config.
npx bejamas infonpx bejamas info --jsonProxy to shadcn docs for component docs, examples, and API links.
npx bejamas docs comboboxnpx bejamas docs combobox --jsondocs:build
Section titled “docs:build”Generate MDX docs from comments in .astro files (props/slots/usage).
Use docs:build explicitly for generation. The plain docs command is reserved for the shadcn docs lookup wrapper.
Usage
npx bejamas docs:build [--in "src/components/**/*.{astro,ts}"] [--out docs/components] [--overwrite] [--dry-run]Example (in a .astro file)
---/** * Pricing Table * @prop plans Plan[] list of plan objects * @prop highlight string tier to emphasize * @a11y All interactive controls are keyboard reachable * @usage Keep headings 1–2 lines; prices use <sup> for currency */---docs:check
Section titled “docs:check”Validate documentation completeness for all components. Reports missing required fields, incomplete docs, and provides a summary.
npx bejamas docs:check [--cwd <path>] [--json]Options
Section titled “Options”--cwd <path>- Path to UI working directory--json- Output results as JSON for CI integration
Documentation Fields
Section titled “Documentation Fields”Required:
@component- Component name@title- Display title@description- Short description
Recommended:
@preview- Primary visual example@usage- Code usage examples@figmaUrl- Figma design URL
Optional:
@examples- Additional examples