Checking the toolchain
AEL, the Agent Engineering Language, will come with installers for Linux, macOS and Windows, with target management and a health check. ael doctor (command names may change before launch) will be that health check: it will report the toolchain, the installed targets and anything missing.
Status
Planned for AEL Beta 0.0.1. AEL is not available yet.
Usage
ael doctor
ael doctor --json
| Option | Meaning |
|---|---|
--json | The report in machine-readable form. |
What it checks
It will check:
- 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 will keep 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 yet.
Each finding will come with the action that fixes it: the target to install, the tool that is missing, or the version that is needed. The command will end with a failure status only when there is a blocker.
Nothing else to install
Desktop and server programs will need nothing else installed: the AEL toolchain will take your code all the way to a native program. Microcontroller boards will be the exception: flashing a board will use its maker's standard tools, which you install yourself, and ael doctor will tell you when they are missing.
What it never does
- It will never print a credential, a token or a secret value, even when it tests a model connection.
- It will install nothing and change nothing. To add what a target needs, use
ael target install.
Related
- Setting up a target: what a target needs, installed and verified.
- Installing AEL: how AEL will be installed.
- Planned targets: the targets planned for Beta 0.0.1.