DISCLAIMER: This is a pre-alpha release and currently under heavy testing and scrutiny. Until the first stable version (v1.0.0) is released, we advise not to use this in production.
Full-stack scaffolding for TypeScript ecosystems. Additional runtimes and stacks may follow.
FivFold adds Kits to your project via CLI: composable features (UI and optional backend scaffolding) as source you own—not a black-box dependency. Built on shadcn/ui and Tailwind CSS v4.
- UI CLI (
@fivfold/ui): initialize and add Kits to React / Next.js (and compatible) apps. - API CLI (
@fivfold/api): scaffold backend modules aligned with your stack (framework, database, ORM) using the same manifest-driven model.
Use list on each CLI to see what Kits are available for that channel. Kits evolve over time; manifests in ui/manifests/ and api/manifests/ are the source of truth.
pnpm workspace with four packages:
flowchart TB
subgraph packages [Packages]
core["@fivfold/core"]
ui["@fivfold/ui"]
api["@fivfold/api"]
site[fivfold-site]
end
core --> ui
core --> api
ui -->|devDependency for demos| site
| Package | Description |
|---|---|
| @fivfold/core | Shared engine: VFS, StrategyPipeline, manifests, TemplateEngine, TsMorphEngine, detection, prompts |
| @fivfold/ui | Frontend Kits CLI: init, add, list, agents, setup |
| @fivfold/api | Backend scaffolding CLI: init, add, list |
| fivfold-site | Next.js docs site |
Prerequisites: Node.js 20+, pnpm
pnpm install
pnpm run build
pnpm run dev:site| Command | Description |
|---|---|
pnpm install |
Install all workspace dependencies |
pnpm run build |
Build all packages |
pnpm run build:core / build:ui / build:api |
Build one package |
pnpm run dev:site |
Docs site (dev) |
pnpm run build:site |
Docs site (production build) |
pnpm release |
Interactive version bump for published packages (see scripts/release.mjs) |
UI CLI (in a consumer project):
| Command | Description |
|---|---|
npx @fivfold/ui init |
Initialize FivFold |
npx @fivfold/ui add <kit> |
Add a Kit |
npx @fivfold/ui list |
List Kits available from this CLI |
npx @fivfold/ui agents |
Agent-oriented instructions |
npx @fivfold/ui setup |
e.g. shadcn alignment |
API CLI (in a consumer project):
| Command | Description |
|---|---|
npx @fivfold/api init |
Initialize FivFold |
npx @fivfold/api add <kit> |
Add a backend Kit |
npx @fivfold/api list |
List Kits available from this CLI |
fivfold/
├── core/src/ # VFS, strategy, manifest, template, AST, detection, prompts, workspace
├── ui/ # UI CLI — src/, manifests/, templates/
├── api/ # API CLI — src/, manifests/, templates/
├── site/ # Docs site (Next.js App Router)
├── AGENTS.md # AI / contributor architectural rules
├── CONTRIBUTING.md # How to contribute
└── package.json
Kits are defined by declarative manifests (*.kit.json) under ui/manifests/ and api/manifests/. They declare templates, dependencies, and AST targets; the CLIs orchestrate generation without hardcoding every stack combination.
- File:
fivfold.jsonat the consumer project root (created byinit). - Shared by: UI and API CLIs (paths, stack choices, etc.).
- AGENTS.md — Architecture, constraints, and documentation conventions.
- CONTRIBUTING.md — Setup, workflow, package-specific notes.
- Build core before ui / api (workspace dependency).
- The docs site depends on
@fivfold/uifor demos; builduiwhen working on site features.
MIT