Class reference

Here every item has its own page: a brief, a description, property/parameter tables, method tables, signal tables, and links to the source.

These pages are generated

The class reference is generated by scripts/gen_reference.py from three real sources, not written by hand:

1. entelechy help --json: the tables the compiler, ABI, parser, replayer and protocol execute (types, builtins, forms, capabilities, operations, fields, replay lines, commands).
2. A running session: entelechy serve on each package, its kernels and kernel operations giving every Kernel’s manifest and source, parsed for functions, types, graph presets and tests.
3. rustdoc JSON: each crate’s public structs, enums, traits, functions and constants.

So what is listed is what the implementation accepts. Pages are marked “generated”; descriptions keep the source’s own text.

Section	Pages	What
Types	27	Float, Vec4, Image, Grid<T>, Rows<T>… each type’s shape, layout and builtins
Builtins	8 kinds · 114	math, construction, conversion, field, context, memory, scatter, group; each with signatures and the capability it needs
Capabilities	4	what field.read, field.write, input.read, time.read grant and which builtins need them
Language	4	Kernel syntax, scene syntax, packages, replay lines
Protocol · Session	24 operations	the Session’s methods (operations), signals (events), envelope and doors
Commands	17	every entelechy subcommand and its flags
Packages	19	each standard package’s Kernels, functions, types, presets and tests
Crates	23	each Rust crate’s public API (rustdoc)

Reading a page

• Brief: one sentence.
• Description: the source’s own text.
• Properties / parameters / methods / signals: structured tables.
• Sources in the footer: the files the page’s data came from, linked on GitHub.

From the command line

The same is always available from the executable:

entelechy help                # all of it, one Markdown text (the same as docs/REFERENCE.md)
entelechy help sample         # every item of one name
entelechy help field.read --json

or over the protocol: {"op":"help","name":"sample"}.