Checking the toolchain
ael doctor is the health check of AEL, the Agent Engineering Language: it reports the toolchain, the installed targets and anything missing. The AEL 1.0.0 build for Linux, macOS or Windows comes with target management and a health check.
Usage
ael doctor
ael doctor --json
| Option | Meaning |
|---|---|
--json | The report in machine-readable form. |
What it checks
It checks:
- The toolchain. That the
aelcommand and the parts it needs are installed, complete and of versions that work together. - Targets. That each installed target is complete and matches what was verified when it was installed.
- Board tools. That for each board target you installed, the board maker's standard flashing tools are present.
- Your machine. Enough disk space, and the
aelcommand found where your shell looks for it. - Model connections. Optionally, whether configured model endpoints answer.
Blockers and options
The report keeps two kinds of finding apart:
- Blockers: something that stops AEL from building at all, such as a damaged installation or an incompatible version.
- Missing options: something only one feature needs, such as the flashing tools of a board you have not used before.
Each finding comes with the action that fixes it: the target to install, the tool that is missing, or the version that is needed. The command ends with a failure status only when there is a blocker.
Nothing else to install
Desktop and server programs written in AEL alone need nothing else installed. Microcontroller boards are the exception: flashing a board uses its maker's standard tools, which you install yourself, and ael doctor tells you when they are missing.
What it never does
- It never prints a credential, a token or a secret value, even when it tests a model connection.
- It installs nothing and changes nothing. To add what a target needs, use
ael target install.
Related
- Setting up a target: what a target needs, installed and verified.
- Getting AEL 1.0.0: how to request the build and what it sets up.
- Supported targets: every target and its profile.