Overview

Eidos is a way to define a product in markdown: an app, a book, a study, anything you set out to make. One file is the complete source of truth for one unit of it, as true of something planned as of something long shipped.

The files are plain .md in your repository. No service, no lock-in. One command, eidos, does the mechanical work.

The one idea

A blueprint says what a thing is and why, never the work of building it. A task dies when the work ships. A blueprint stays accurate for the product’s whole life.

Where to start

Quick StartInstall the CLI, create a root, write your first blueprint.

Why Eidos ExistsThe problem it solves, and when not to use it.

Use CasesA software team, a solo builder with agents, a studio, a book: who it is for and what it speeds up.

The CLIWhat eidos does, command by command.

The four ideas

Framework & Blueprint

The framework is the structure. A blueprint is one unit written in it. Read →

Collections & Blueprints

A collection is a folder of blueprints of one kind. A blueprint is one file: properties on top, a body below. Read →

Templates & Variants

A template is the body a collection’s blueprints follow. A variant is one of a collection’s templates. Start light, grow into full. Read →

Properties

The frontmatter contract: four core properties from the standard, plus whatever your framework adds. Read →

This site and the standard

These pages teach Eidos. The standard is one file, EIDOS.md. Where the two disagree, the standard wins.

Tip

Everything here describes Eidos 5.5.0, as carried by CLI 0.14.0. Versioning →