Documentation

Build with Protoyard

Public guides for using Protoyard and its tools.

• Quickstart

  From a fresh clone to your own exported prototype. The first section takes

• Agent guide

  How a coding agent (or a person working like one) takes a prototype from an

• Quick explorations

  protoyard quick creates a disposable, local prototype from a brief or a

• Protoyard Player

  The player is the no-install way to explore a blueprint. It derives a working

• Generator: blueprints to prototypes

  A blueprint is a data-only JSON description of a product: entities with typed

• From a brief to a prototype

  Protoyard can turn a short product description into a data-only blueprint,

• Database

  Every prototype has a real database in the browser: IndexedDB through

• Scenarios, personas, time and environment

  A scenario answers one question: what does this app look like for this

• Themes

  Every prototype has its own look: a theme, a color mode and a motion

• Layouts

  A layout is the page structure around a prototype's routed screens: navigation,

• Shells

  A shell presents a prototype as the product it simulates: a phone, a tablet, a desktop

• Views kit

  The views kit adds focused screens beyond CRUD: boards, calendars, plans,

• Charts

  Protoyard's own chart kit, with no third-party chart library

• Analytics

  Everything a prototype needs to look and behave like a product-analytics or

• SaaS kits

  Protoyard's SaaS kits add realistic, browser-local product flows to a prototype:

• AI kits

  Protoyard’s AI surface is a deterministic simulation platform for

• Avatars

  Protoyard ships a library of 175 portraits of fictional people

• Publishing

  A prototype builds into a plain static site: HTML, JS and CSS, with no server,

• Review comments

  Reviewers pin comments to a built prototype. They click a spot on a screen,

• Prototype specs

  Every prototype should ship a spec: a small set of documents next to the

• Packages

  Protoyard is a pnpm workspace of small packages. Install only the pieces an app uses: the engine packages hold data and runtime behavior, while Svelte packages render it. The repos

• Protoyard skill

  Protoyard's distributable agent skill lives in skills/protoyard/ in the

• Protoyard machine interface

  Tools that drive Protoyard, such as a DeepWorkPlan addon, an MCP client or a

• Model Context Protocol (MCP)

  Protoyard includes a local MCP server in the protoyard CLI. It lets an MCP-capable agent call a fixed set of Protoyard operations in the workspace where the server runs. It is a st

• DeepWorkPlan integration

  Protoyard can serve as an optional validation step inside a

• Security Model

  How to report vulnerabilities: ../SECURITY.md. This page