AgentOnboard Docs
CLI Reference

aon doctor

Diagnose your AgentOnboard CLI setup — run aon doctor after installing or when something misbehaves

aon doctor

Run a set of diagnostic checks against your local setup. Use it after installing, after changing your configuration, or whenever a command behaves unexpectedly.

Usage

aon doctor

aon doctor checks that your setup is ready to use:

  • Your configuration is valid
  • Your saved keys file is valid
  • The API is reachable
  • Your latest key can be exchanged for a session token

It prints the result of each check, one line at a time.

Example output

A healthy setup:

aon doctor
# API: ✓
# Config: ✓
# Tokens: ✓
# Key: ✓

Exit code

aon doctor reports its overall result through its exit code:

  • 0 — your config, tokens file, and API are all OK
  • 1 — at least one of those checks failed

This makes it easy to run aon doctor in a script or a setup check and act on the result.

The key check is informational

If you have not saved a key yet, the key check is skipped. That does not make aon doctor fail — the other checks still decide the exit code.

Fixing common failures

CheckHow to fix
Config failedRun aon config show to inspect, then aon config set apiUrl <url> or aon config reset apiUrl
Tokens failedRe-save your key with aon save
API unreachableCheck your connection, or that apiUrl points somewhere reachable
Key invalidSave a valid key from your dashboard

Next steps

On this page