Froth, and this site, are pre-alpha. This site is largely OSAI-generated documentation from the Froth repo.

Use the reference when you need the exact surface rather than the teaching arc.

If you want the board as a first-time user rather than as a reference reader, start with Machine .

The main sections are:

  • Word reference for syntax, operators, locals, Cells, records, and the core inspection/persistence words
  • Interactive profile for REPL behavior, multiline input, interrupts, and inspection
  • Image and persistence for base versus overlay and the recovery surface
  • CLI for the maintained command-line path
  • Editor for the visible VS Code control surface
  • Project and build for target, board, and project build conventions
  • FFI for the Froth/C boundary
  • Machine board reference for board words, display, input, utilities, and the shared base-image surface
  1. Word Reference Core syntax, operators, state, collections, and prompt-facing built-ins.
  2. Interactive Profile REPL behavior, multiline input, interrupts, inspection, and the control-session path.
  3. Image and Persistence Base versus overlay, rebinding, `save`, `restore`, `dangerous.wipe`, and `boot`.
  4. CLI The maintained `froth` command surface and attendee-versus-maintainer paths.
  5. Editor The visible VS Code control surface: connect, send, inspect, interrupt, and recover.
  6. FFI The Froth/C boundary, from runtime registration to project-local bindings.
  7. Hardware Machine board words for display, input, utilities, and the shared base-image surface.
  8. Project and Build Project file names, target versus board selection, build directories, and flashing policy.