Overview
Reference for the AgentOnboard CLI — built for AI agents, used by agents, no manual work needed
CLI Reference
The aon CLI is the official command-line tool for AgentOnboard. It is published to npm as @agentonboard/cli.
Built for your agents, not for you
The aon CLI is designed to be used by AI agents, not by people. It exists so that an agent can authenticate with and use third-party services on your behalf — without you ever touching a command line. In most cases the CLI is installed and run by your agent automatically and you never need to use it.
You don't need to use aon. There's no requirement for you to run anything by hand. If you do want to see what it can do, or you're troubleshooting, the rest of this page shows how — but it's entirely optional.
The pages in this group cover:
aon save— save an API keyaon token get— exchange a key for a 5-minute session tokenaon list— show saved keysaon config— show and manage configurationaon directory— explore the partner directoryaon doctor— check that everything works- Storage — where the CLI keeps your state
Install
npm install -g @agentonboard/cliVerify your install
Run aon (no arguments) or aon help to print usage.
How it works
Not for you — for your agents
The aon CLI is what your AI agents use under the hood to operate services for you. You don't set it up or run it.
Agents save and use keys
An agent saves an API key with aon save and exchanges it for a short-lived session token with aon token get whenever it needs to call a service.
Your keys stay with you
Your long-lived API key stays on your machine. Agents only ever get short-lived session tokens, valid for 5 minutes.
Optional check
If you ever run into trouble, aon doctor verifies everything is configured correctly.
Quick start
Create an account
Sign up at ao.aawej.in and generate an API key from your dashboard.
Save your key
aon save <your-api-key>Get a session token
aon token getCheck your setup
aon doctorThis page is here for you and for the agent. But remember — in normal use you never have to touch the CLI at all.
Command reference
| Command | Description |
|---|---|
aon save [label] <key> | Save an API key, optionally with a label |
aon token get [label] | Exchange a key for a 5-minute session token |
aon list | Show saved keys |
aon config show | Show the current configuration |
aon config get <k> | Get a config value |
aon config set <k> <v> | Set a config value |
aon config reset <k> | Reset a config value to its default |
aon directory list | List partners in the directory |
aon directory get <slug> | Show details for a partner |
aon doctor | Check config, tokens, API, and key validity |
The only config key today is apiUrl. Most commands just show information — the ones that change anything are config set, config reset, and save.
The global --json flag
Use --json with directory commands for machine-readable output. See the aon directory page for how it works.
Where state lives
The CLI keeps everything in ~/.agentonboard/:
config.json— configuration (theapiUrloverride)tokens.json— saved API keys
See Storage for the full layout and how to debug or reset it.
Next steps
Example app: The action — create & read notes
The two endpoints an agent actually uses — GET and POST /api/notes — with query filters, zod body validation, response shapes, and a worked end-to-end example
aon save
Save an API key with the AgentOnboard CLI — signature, labelling, and where the key is written