CLI
Command-line reference for FivFold UI and API packages. All commands support standard help flags.
Prompt flow & auto-detection
The CLI deduces choices sequentially: Runtime → Framework → ORM → Auth (when applicable). It parses package.json to detect your existing stack and silently skips relevant prompts. Use --yes to bypass all questions with smart defaults.
fivfold (ui)
The @fivfold/ui package provides the fivfold binary. Run commands with npx @fivfold/ui <command>.
init
Initialize FivFold in your project
Detects existing shadcn/ui installation, prompts for theme preferences (keep existing or apply FivFold theme), creates fivfold.json, and sets up globals.css. Optionally runs shadcn init if not present.
npx @fivfold/ui initadd <kits...>
Add one or more Kits
Installs npm dependencies, runs npx shadcn@latest add for required primitives, and copies the Kit template to your configured kits path. Supports multiple Kit names in one invocation.
Options
--theme <color>Override base color: neutral, slate, gray, zinc, stone--yes / -ySkip prompts, use defaults--dry-runPreview changes without writingnpx @fivfold/ui add <kit> [--theme zinc] [--yes] [--dry-run]list
List available Kits
Displays all available Kits with descriptions and their shadcn/ui dependencies.
npx @fivfold/ui listagents
Generate AGENTS.md
Creates AGENTS.md at project root with your FivFold setup, conventions, theming, and installed Kits. Helps AI coding assistants understand your project context.
Options
--forceOverwrite existing AGENTS.mdnpx @fivfold/ui agents [--force]setup
Show setup instructions
Checks for shadcn/ui, fivfold.json, and Tailwind v4. Prints requirements status and quick-start commands.
npx @fivfold/ui setupfivfold (api)
The @fivfold/api package provides the fivfold-api binary. Run commands with npx @fivfold/api <command>.
init
Configure backend stack
Prompts for framework, ORM, database, and output directory. Saves configuration to fivfold.json. Auto-detects existing stack from package.json.
Flags
--yes / -yUse defaults, skip prompts--dry-runPreview config without writing--framework=...Framework choice--orm=...ORM choice--provider=...Auth provider (when applicable)npx @fivfold/api init [--yes] [--dry-run] [--framework=...] [--orm=...]add <module>
Add an API module
Scaffolds entities, DTOs, services, and controllers (or routes) based on your configured stack. Copies files to the output directory and prints integration instructions from the module README.
Flags
--dry-runPreview staged files without committing--provider=...Auth provider (when applicable)npx @fivfold/api add <module-name> [--dry-run] [--provider=...]list
List available API modules
Displays all available API modules and their supported stacks.
npx @fivfold/api list