Overview

Yoshi is a Rust CLI that turns a blueprint (a structured description of a business) into a complete, buildable Next.js site — 1,500–2,800 static pages from one command.

These are the technical docs: the CLI, the blueprint schema, the architecture, and the APIs. If you're a business owner looking to use Yoshi, you want the product guide instead.

The shape of it

  blueprint/            yoshi generate          out/
  ├── config.json   ──────────────────▶   a complete Next.js project
  ├── products.json                         (~75 source files, ~1,800 pages)
  ├── cities.json
  └── …                                     pnpm build → static `out/` → deploy to the edge

One binary, one command, no template directory — the skeleton is embedded in the binary at compile time (include_dir!). Every run is deterministic: the same blueprint produces the same site, individuated per business by seeded uniqueness axes (layout, typography, palette, images, style-DNA).

What's in these docs

  • Quickstart — install + generate your first site.
  • Concepts — the architecture (the egg, the base/type split, the raw skeleton), the blueprint, and the site TYPE system.
  • Reference — the CLI commands and the HTTP APIs (the Perf API is the first one live).