Reference
Technical reference documentation
Complete technical reference documentation for Korall Engineering™. This section provides accurate, detailed specifications.
Pro Tip
Reference documentation is designed for looking things up, not reading cover-to-cover. Use the glossary to find definitions, the API reference for class details, and the specific sections (nodes, plans, comms) for topical deep dives.
Quick reference
| Resource | Description |
|---|---|
| Glossary | Terminology and definitions |
| API reference | Auto-generated class and function documentation |
Reference sections
| Section | Description |
|---|---|
| Nodes | The node types and their specifications |
| Plans | Plan file format and commands |
| OPAL | OPAL command interface for LLM integration |
| Spec database tasks | The spec.* tasks, the door's tasks and the answers of a call through the door |
| The trove command line | Every verb, option and exit code of the trove tool |
| Communications | Protocols, couriers, and sessions |
| Media | Audio and video processing, device management, streaming |
| Hardware | Actuators, sensors, lobes, and ArduMY |
| Configuration | Settings, key storage, and CLI options |
| Editions | The edition.json schema for branded builds |
| Qbs Build System | Qbs architecture, modules, probes, and configuration: the second build path, until qbs retires |
| Build tools | The C++ programs the build uses, and how to run one by hand |
| Build runner | The default build path: the kiln command, kiln test and its profiles, and the .kiln keys |
| Test harnesses | The shared fakes, fixtures and helpers that test suites use |
| Android Build | Android build architecture, configuration, and deployment |
| Clockwork | Stored schedules that start batch jobs: the two syntaxes, summer time, overlap, catch-up and the clockwork tasks |
| Batch artifacts | The job contract for files: inputs and outputs by hash, how they travel between nodes, and the artifact tasks |
| Fleet | Rented machines: configuration keys, lifecycle states, reconcile findings, and the fleet and oci tasks |