Browse the documentation

Early preview

Tutorials

These tutorials take you through the Open Engineering Language one task at a time, from a first agent to services, devices and deployments. Each one builds on the reference pages it links, uses the commands and files of Compiler 1.0.0, and ends with the limits to know about. Complete example agent systems and deployment recipes come with Compiler 1.0.0.

Getting the Compiler says how to request the build for your platform, and A first agent is the shortest way in.

The tutorials

The example index

Every sample of these tutorials, in the order it appears. The last column says what a sample needs to compile: samples of Core declarations (structures, enums and functions) compile on their own, as a library; the other samples are parts of a project, such as an agent, a node, a hook, a routes file, a project file or an excerpt, and compile with Compiler 1.0.0 as part of the project they come from.

TutorialSampleWhat it showsCompiles with
Your first agent, end to end1The typed request and its checkCore declarations, on their own
Your first agent, end to end2The node, with its prompt, model binding and attemptsCompiler 1.0.0, in its project
Your first agent, end to end3The entry point that starts the agentCompiler 1.0.0, in its project
Typed inputs, checks and policies1The typed review request and its input checkCore declarations, on their own
Typed inputs, checks and policies2The review node and its input builderCompiler 1.0.0, in its project
Typed inputs, checks and policies3Hooks in ordered groups around an agentCompiler 1.0.0, in its project
Services and retrieval1The advisor's retrieval workflowCompiler 1.0.0, in its project
Services and retrieval2The retrieval nodeCompiler 1.0.0, in its project
Services and retrieval3The answer nodeCompiler 1.0.0, in its project
Services and retrieval4The citation check nodeCompiler 1.0.0, in its project
Services and retrieval5The edge from evidence to answerCompiler 1.0.0, in its project
Services and retrieval6The edge from answer to checkCompiler 1.0.0, in its project
Fanning out to subagents1The issue reader subagentCompiler 1.0.0, in its project
Fanning out to subagents2The issue reader's nodeCompiler 1.0.0, in its project
Fanning out to subagents3The node that spawns one subagent per issue and joins themCompiler 1.0.0, in its project
Fanning out to subagents4The triage agentCompiler 1.0.0, in its project
Fanning out to subagents5The first answer with join_anyCompiler 1.0.0, in its project
Fanning out to subagents6Canceling a reader no longer neededCompiler 1.0.0, in its project
Fanning out to subagents7Spawning only when a slot is freeCompiler 1.0.0, in its project
Boards and the gateway1A sensor check with no heapCore declarations, on their own
Robot safety and replay1The robot agent's proposal workflowCompiler 1.0.0, in its project
Robot safety and replay2The planning nodeCompiler 1.0.0, in its project
Robot safety and replay3The command check nodeCompiler 1.0.0, in its project
Robot safety and replay4The edge between themCompiler 1.0.0, in its project
Robot safety and replay5The deterministic validatorCore declarations, on their own
Extending the language1An authorization hookCompiler 1.0.0, in its project
Extending the language2The metadata of a package projectCompiler 1.0.0, in its project
Extending the language3Selecting a package's exportCompiler 1.0.0, in its project
Calling your programs, with reports1Your scoring script as a typed toolCompiler 1.0.0, in its project
From console agent to HTTP API1A routes fileCompiler 1.0.0, in its project
Packages: add, update and offline builds1Selecting an export in a file headerCompiler 1.0.0, in its project

Honest limits

  • Helpers whose body holds only a comment are placeholders, as A first agent explains: a sample that shows one compiles once the helper has its body.
  • The tutorials name no target or board: they write <target> and <board>, and Supported targets lists them.
  • No tutorial states a time, a size or a memory figure; where one matters, the tutorial says how you measure it.