Installation & Quickstart
Get started with Exhuma using the interactive starter wizard or install components directly into your existing project across any package manager.
- Tailwind CSS · clsx
- pnpm · npm · bun · yarn
Prerequisites & Styling Engine
Exhuma components use standard CSS variables and Tailwind CSS for styling, paired with clsx for class merging. We ship zero runtime animation engines (no Framer Motion or GSAP). Before installing, ensure your project has:
Tailwind CSS (v3 / v4)
CSS Variables
--background, --card, --border) for seamless dark mode.clsx
Interactive Starter Wizard
The fastest way to scaffold a new project with Exhuma pre-configured is using the official starter wizard:
The wizard will prompt you for your project name and preferred framework, then generate a lightweight project with self-contained tactile components ready to run.
Supported Package Managers
Exhuma supports all major modern JavaScript package managers without installing global binaries:
pnpm
pnpm dlx exhuma add <slug>npm
npx exhuma add <slug>bun
bunx exhuma add <slug>yarn
yarn dlx exhuma add <slug>Initializing Existing Projects (exhuma init)
To configure Exhuma in an existing codebase, run the initialization command in your repository root:
# Initialize configuration
npx exhuma init
# Automatically detects framework (React, Next.js, Vue, Svelte, Angular, Astro...)
# Creates an exhuma.json config fileConfiguration File (exhuma.json)
The generated exhuma.json stores your framework flavor and preferred component directory:
{
"$schema": "https://exhuma-ui.com/schema.json",
"flavor": "nextjs",
"paths": {
"components": "@/components/ui"
}
}Adding Your First Component
Once initialized, install any canonical component with a single command:
# Install 3D Tilt Card
npx exhuma add tilt-card
# Install Stacking Cards
npx exhuma add stacking-cards
# Overwrite existing if updating
npx exhuma add horizontal-scroller --overwrite