Expand description
Running a plugin, and finding out whether one can be run at all.
§THE PROTOCOL, IN FULL
A plugin is a program, or a container image holding one, that answers two verbs and nothing else.
describe prints one JSON object and exits 0. run reads newline
delimited work items on stdin and prints one record per item on stdout,
with progress on stderr.
Two verbs is the whole contract. Sharding, timeouts, memory caps, container lifecycle, retries and resumption are the host’s job, and no plugin author ever thinks about them. That is what makes “contribute a detector” mean writing thirty lines in any language rather than learning our internals.
§AN ERROR IS A RECORD, NOT AN ABSENCE
A plugin that cannot score an image says so, in a record carrying the same id. On 2026-09-17 resume logic here treated an empty failed record as complete, so a re-run scored nothing while printing “resuming: 1480 files already scored”. A record is done when it carries a score or an error, never when it merely exists.
Re-exports§
pub use availability::registry_reach;pub use availability::Availability;pub use availability::Presence;pub use availability::Reach;pub use parsers::Reading;pub use selftest::Verified;
Modules§
- adapter
- Finding the host adapter a registry entry names.
- availability
- Can this tool be run on this machine, and do we know that it works?
- embed
- Running an embedder over a cover the user chose.
- exec
- Running a plugin and waiting for it, but never for ever.
- parsers
- Reading what each classic tool actually prints.
- runner
- Scoring a corpus: one tool, many items, and a run that survives being interrupted.
- selftest
- Asking a tool both questions, and believing it only if it gets both right.
Structs§
- Describe
- How a plugin describes itself.
- Record
- What a plugin says about one item.
- Work
Item - One item of work handed to a plugin.
Enums§
- Plugin
Error - Version
Probe - What a version probe produced, and whether it can be believed.
Constants§
- DEFAULT_
HOST_ ENTRYPOINT - What runs a host adapter when its entry names no entrypoint.
Functions§
- binary_
version - Asks a binary plugin what version it is, using the arguments its entry declares, and refuses an answer that cannot be a version.
- hash_
file - The SHA256 of a file, which is how a binary plugin is pinned.
- which
- Finds an executable the way a shell would, so a registry entry can name
stegcorerather than an absolute path that differs per machine.