Introduction
Hypha is an open-source commerce API written in Rust, with an admin panel and a storefront built on it. It runs on your own server or on Cloudflare Workers, grows through apps and Rust plugins instead of forks, and lets AI agents operate a store with exact previews and approvals.
What’s included
Section titled “What’s included”| Area | What you get |
|---|---|
| Catalog | Products with options and sparse, explicit variants, categories, media, rich text, custom fields, search with facets |
| Selling | Markets (countries and currency), catalogs and price lists, sales channels, tax regions and classes |
| Checkout | Carts priced per market, shipping zones and rates (or a rate app), manual payment methods and online payments started before the order exists |
| Orders | Fulfilment by location with tracking, cancellations, refunds, inventory per location |
| Customers | Accounts with email sign-in codes, addresses, marketing consent, data export and erasure |
| Staff | Roles and scopes, two-factor sign-in, invites, API keys |
| Jinja templates with previews and test sends, sent over SMTP or Resend | |
| Extending | Events and webhooks, apps installed over OAuth 2.1, spores (Rust plugins compiled in) |
| AI agents | An MCP server for the admin, with exact previews of any write and proposals staff approve |
How the pieces fit
Section titled “How the pieces fit”The API is the product: two HTTP surfaces, described by OpenAPI documents.
- The admin API (
/admin/*) is for staff sessions, secret API keys, installed apps and agents. - The storefront API (
/storefront/*) is for publishable keys and signed-in shoppers. It never shows drafts or admin-only fields.
The admin panel and the storefront are applications on those APIs, written in
TypeScript (Next.js on Vite). You can run them as they are, start your own from them, or
build a frontend from scratch on the typed SDK, @hyphacommerce/sdk.
Everything you add goes through the same commands the core uses. Every operation has typed input, the scopes it requires and typed errors, so an app, a plugin, an agent or your own frontend can’t skip a rule the core enforces.
Where to start
Section titled “Where to start”- Run it locally: the API, admin and storefront on your machine, with a demo store.
- Deploy it: to your own server or to Cloudflare Workers.
- Concepts: how stores, markets, products, orders and payments work.
- Build an app, write a spore or connect an AI agent.
- The admin API and storefront API references.