AgentOnboard Docs
User Guide

Quick Start

From zero to a connected agent in about five minutes — create an account, save an API key, and connect your AI agent

Quick Start

Get from zero to a connected agent in about five minutes: create an account, generate an API key, and paste one prompt into your AI agent. You will need a Google or GitHub account and a terminal where your agent can run commands.

1. Create your account

Go to ao.aawej.in and sign in with Google or GitHub. Your account is created the first time you sign in — no separate signup form.

Remember the email you use

The email you sign in with becomes your AgentOnboard identity. Partner services recognise you by this email, so use one you can keep — see Email & identity.

2. Create an API key

From your dashboard at ao.aawej.in/dashboard, click Create Key:

  1. Give the key a descriptive label, for example My Cline agent.
  2. The raw key is shown exactly once in a dialog — copy it now. You will not be able to see it again.

Store the key somewhere safe

Your key grants access to your AgentOnboard account. Treat it like a credential — never commit it to source control, and revoke it from the dashboard if it ever leaks.

3. Install the CLI

The aon CLI is what saves your key and mints session tokens. Install it globally with your package manager of choice:

npm install -g @agentonboard/cli

Verify the install by running aon on its own — it prints usage.

4. Save your key

Save the key you copied in step 2:

aon save <your-api-key>

The key is stored on your machine in ~/.agentonboard/. You can give it a label — aon save my-agent <your-api-key> — if you plan to save more than one. See aon save for the full details.

5. Connect your agent

Now give your agent access. The easiest way is to paste the ready-made prompt from your dashboard:

Open the prompt

Sign in, open the Connect Agent page from the dashboard sidebar, and copy the prompt under Copy this prompt.

Paste it into your agent

Paste the prompt into your AI agent (Claude Code, opencode, and similar). The agent installs the AgentOnboard skill, checks the CLI, and helps you save your key if you have not already.

Let the agent work

Once set up, tell the agent which service to use. It looks up the partner directory, exchanges your key for a session token, and acts on your behalf.

The exact prompt and what each step does are documented on Connect AO with your agent.

6. Check everything works

Run the built-in diagnostic to confirm your setup is healthy:

aon doctor

It checks your configuration, your saved keys, that the API is reachable, and that your key can be exchanged for a session token. See aon doctor for what each check means.

Tokens last 5 minutes

Your agents never send your long-lived key to anyone. When they need to call a service, they exchange the key for a session token that is valid for 5 minutes — see Connecting an agent for how that handshake works and why it is safe.

Next steps

On this page