CLI Reference & Commands
The official exhuma command-line interface provides autonomous framework detection, canonical component retrieval, and offline code generation.
- 4 commands
- Works offline
CLI Overview
The CLI package is published under exhuma on npm. It can be invoked on-demand via npx, pnpm dlx, bunx, or yarn dlx without requiring global installation:
# Display version
npx exhuma --version
# Display global help
npx exhuma --helpexhuma init
Configures Exhuma within your existing project by generating an exhuma.json configuration file.
# Interactive initialization
npx exhuma init
# Non-interactive initialization with explicit flavor
npx exhuma init --flavor=svelte --path=src/lib/components -y| Flag | Type | Description |
|---|---|---|
| --flavor, -f | string | Target framework contract (react, nextjs, svelte, vue, etc.) |
| --path, -p | string | Custom destination directory for components |
| --yes, -y | boolean | Skip confirmation prompts and accept defaults |
exhuma add <slug>
Retrieves and writes the canonical component implementation into your workspace.
# Add single component
npx exhuma add stacking-cards
# Override target flavor on-the-fly
npx exhuma add tilt-card --flavor=flutter
# Overwrite existing component files
npx exhuma add masonry-grid --overwrite
# Add all canonical components at once
npx exhuma add --all| Flag | Type | Description |
|---|---|---|
| --all, -a | boolean | Installs all 20 canonical components |
| --overwrite, -o | boolean | Forces file overwrite if already present |
| --flavor, -f | string | Target framework contract override |
| --path, -p | string | Explicit destination directory for this command |
exhuma list
Inspects available canonical components, categories, and supported frameworks:
npx exhuma listexhuma build
Generates static registry JSON files for CDN hosting (such as Vercel Edge output in public/registry/*.json).
npx exhuma build --output=public/registryOffline Embedded Guarantee
Unlike other CLI tools that fail if internet access is interrupted or an external registry server is down, exhuma packages an embedded fallback dictionary directly within the binary.