Documentation

Reference

The API, generated from the sources, and the things scaladoc cannot say: commands, settings, conventions and file formats, stated once.

The API

Every public type and member, generated from the sources' scaladoc on each build, with a search box and a link from every signature to its source. Browse the API

Everything else

The eezo command line
Every command bin/eezo and sbt "run <command>" answer, with flags, exit codes and what each one touches. The outputs on this page were captured from the…
The sbt plugin
sbt-eezo: the tasks and settings it adds, the source it generates, and the sbt versions it runs on.
Configuration
Every environment variable eezo reads, and every override the entry traits offer, with their defaults. The types are in the API; this page is the values.
Routing conventions
What a file under src/main/scala/app/ mounts, how the generated table is ordered, and what the framework reserves. Route, RouteTable and PathPattern are in the…
Type mappings
What each field type becomes under Table, Form and Resource: the column, the input, the parse, and what an absent submission means. The types are in the API:…
Migrations
The files under db/, the header a migration carries, the ledger table, and the output of the commands over them. The files on this page are the bookshelf's…
The live wire protocol
What travels between a live page and the server: the anchor's attributes, the frames in both directions, the patch kinds, the close codes and the limits.…
Deployment files
What eezo build stages, what eezo deploy writes, and every field in the generated fly.toml. The staged files on this page are the bookshelf's.
Vocabulary
A Scala 3 web framework where the case class is the source of truth. A model declares what it is, and eezo derives its HTML form, its routes and, later, its…