Kumiko Documentation
Declare a feature in TypeScript — get a Postgres table, typed API, access control, and admin UI.
Kumiko is a code-first framework for building multi-tenant business apps — internal tools, SaaS back-offices, admin panels. You declare a feature — its data, its rules, its screens — in one TypeScript file, and Kumiko builds the database tables, the API, the access control, and a working admin UI from it.
You write the business logic. Auth, multi-tenancy, audit trails, and realtime updates come built in.
Stack: Bun · Hono · PostgreSQL · Redis · React.
How the magic happens
You write a defineFeature() block: entity fields, write handlers, screens.
At boot, Kumiko validates the feature graph, runs migrations, registers handlers
on the command bus, and mounts generated list/edit screens in the admin shell.
Change a field in the entity — the table, API, forms, and labels follow.
No separate ORM layer, no hand-written CRUD routes, no React form boilerplate.
→ Concepts: How Kumiko thinks for the full mental model.
What you get
Section titled “What you get”- Declare data, get a UI — one entity definition produces a SQL table, a typed API, forms, lists, filters, and i18n labels. No glue code.
- Multi-tenant from day one — tenant isolation, roles, and audit are the default, not a six-month project.
- Auth without building screens — add the auth feature and get login, signup, password reset, and invites.
- Realtime by default — changes stream to the browser over SSE; concurrent edits are safe out of the box.
- Dozens of ready-made features — billing, files, notifications, GDPR tooling, background jobs — mount what you need.
→ See everything you get — the 90-second tour.
What Kumiko is not
Section titled “What Kumiko is not”Where to start
Section titled “Where to start”| If you want to… | Go to |
|---|---|
| Get your own app booting in three commands | Quickstart |
Re-skin default chrome with styles.css | Quickstart → Make it yours |
| Build a full app (RSVP, subdomains, mail) | Show Pony tutorial |
Customize the starter tasks feature | Tutorial |
| See what Kumiko can do, fast | What you get |
| Understand how Kumiko works underneath | Concepts |
| Solve a specific task (“I want to do X”) | Guides |
| Run a real app and see the generated UI | Examples |
How this documentation is organised
Section titled “How this documentation is organised”| Section | Content |
|---|---|
| Get started | Install, requirements, and a five-minute browser quickstart. |
| Tutorial | Build your first feature end to end. |
| What you get | Every built-in capability, at a glance. |
| Concepts | The mental model. Why Kumiko works the way it does. |
| Guides | Task-oriented how-tos: “I want to do X — show me.” |
| Examples | Runnable sample apps and focused recipes. |
| Bundled features | Reference for each pre-built feature (auth, audit, files, …). |
| Platform | Deployment topologies (solo, Docker, k3s). |
| Reference | Auto-generated patterns, error codes, and sample READMEs. |