CLI-first alpha

Get started with AXME CLI

Install the CLI, log in with your email, and run your first intent workflow — no API key copying, no web dashboard required.

During alpha the CLI is the primary interface. It handles login, workspace setup, quota visibility, and gives you a working API key in under 5 minutes.

Quick start — four steps

1 Install AXME CLI One-line installer for macOS and Linux. Windows: download from GitHub Releases.
2 Run axme login Enter your email. A one-time code is sent to your inbox — no password, no browser OAuth.
3 Your workspace is ready Login automatically provisions your org, workspace, and API key. Run axme workspace list and axme quota show to confirm.
4 Run your first example Built-in examples run end-to-end with one command. No cloning, no dependencies.

1 — Install AXME CLI

macOS and Linux — one-line installer (downloads a prebuilt binary, no Go required):

bash

curl -fsSL https://raw.githubusercontent.com/AxmeAI/axme-cli/main/install.sh | sh
# Open a new terminal, or run the "source" command shown by the installer
axme version

Windows

plaintext

# Download the latest Windows archive from GitHub Releases:
# https://github.com/AxmeAI/axme-cli/releases
# Extract axme.exe and add to PATH

axme version

2 — Log in with email OTP passwordless

Run axme login and enter your email. A 6-digit code is sent to your inbox:

bash

axme login

🔐 Credentials (API key + JWT + refresh token) are stored in the OS keychain where available. On headless servers they fall back to ~/.config/axme/secrets.json (mode 0600). Tokens refresh automatically — no re-login needed for up to 30 days.

3 — Explore your workspace

bash

axme workspace list          # list workspaces
axme workspace use           # switch active workspace (if you have multiple)
axme quota show              # view usage and limits

output — axme quota show

DIMENSION                         USED    LIMIT  USAGE%
intents per day                      0      500      0%
rate limit per minute                0      120      0%
payload max bytes                    -   262144        -
actors total                         0       20      0%
service accounts per workspace       1       10     10%
storage bytes                        0  1048576      0%
sse streams max                      0        5      0%

overage_mode=block  hard_enforcement=true

4 — Run your first example

⚠️ Requires step 2. Run axme login first — examples use your session credentials.

List all built-in examples:

bash

axme examples list

Each example runs end-to-end with a single command — no cloning, no dependencies. The CLI provisions agents, submits the intent, and streams the lifecycle in real time.

Command	Scenario
`axme examples run delivery/stream`	Compliance Checker — SSE stream delivery. Agent validates change compliance via SSE stream binding. [built-in Go agent]
`axme examples run human/cli`	Human approval via CLI — deployment readiness. Agent checks readiness, then workflow pauses for human approval via `axme tasks approve`. [built-in Go agent]
`axme examples run human/email`	Human approval via email — budget request. Agent validates budget envelope, then workflow sends approval email with magic link. [built-in Go agent]
`axme examples run internal/timeout`	Step timeout — deadline enforcement. Step with 15s deadline, no agent responds. Scheduler enforces TIMED_OUT → FAILED. [built-in Go agent]
`axme examples run full/multi-agent`	Full multi-agent — compliance → risk → CAB approval. Three-step workflow: compliance agent, risk assessment agent, then human CAB sign-off via email. [2 built-in Go agents]

💡 Start with axme examples run human/cli — it shows the full lifecycle (CREATED → DELIVERED → WAITING_FOR_HUMAN → COMPLETED) and lets you approve interactively with axme tasks approve.

Full CLI command reference

All commands available in the current release. Global flags (--json, --org-id, --workspace-id, --base-url) apply to all commands.

Command	Description
Auth
`axme login`	Sign in via email OTP (passwordless). Stores API key, JWT, and refresh token.
`axme login --force`	Force a new sign-in even if current session is still valid.
`axme logout`	Clear session. `--all` also clears API key. `--all-sessions` revokes server-side.
`axme whoami`	Show current identity, org, workspace, and session status.
Session
`axme session list`	List active account sessions. `--all` includes revoked.
`axme session revoke <id>`	Revoke a session. `--current` revokes the active session.
Org & Workspace
`axme org list`	List organizations you belong to.
`axme workspace list`	List workspaces in the active org.
`axme workspace use <name\|id>`	Switch active workspace.
`axme workspace members list`	List members of the active workspace.
`axme workspace members include <actor-id>`	Add an org member to a workspace. `--role member` (default).
`axme workspace members exclude <member-id>`	Remove a member from the workspace (stays in org).
Members (org-level)
`axme member list`	List org-level members.
`axme member add <actor-id>`	Add a member to the org. `--role` required.
`axme member update <member-id>`	Update role or status of an org member.
`axme member remove <member-id>`	Remove a member from the org.
Context
`axme context list`	List all saved CLI contexts (API key, org, workspace per context).
`axme context show`	Show active context details and server-selected workspace.
`axme context use <name>`	Switch active context.
`axme context set <name>`	Create or update a context. Flags: `--api-key`, `--org-id`, `--workspace-id`, etc.
Quota
`axme quota show`	Show current usage and limits for all dimensions.
`axme quota upgrade-request`	Submit a quota increase request. Requires `--company` and `--justification`.
Intents
`axme intents list`	List intents. Filter: `--status`, `--since`, `--limit`.
`axme intents get <id>`	Get full details for a single intent.
`axme intents send --to <agent://...>`	Send an intent to a registered agent. `--service`, `--payload-json`.
`axme intents watch <id>`	Stream live lifecycle events for an intent.
`axme intents resume <id>`	Resume a waiting intent.
`axme intents cancel <id>`	Cancel an intent. `--reason` optional.
`axme intents retry <id>`	Retry a failed intent.
`axme intents cleanup`	Clean up zombie intents (stuck in non-terminal states).
`axme logs <id>`	Show lifecycle event log. `--tail`, `--since`, `--level`, `--step`.
`axme trace <id>`	Show concise execution timeline with `next_action` guidance.
Tasks (human-in-the-loop)
`axme tasks list`	List pending human tasks assigned to you.
`axme tasks get <id>`	Show details of a specific task.
`axme tasks approve <id>`	Approve a pending task.
`axme tasks reject <id>`	Reject a pending task. `--reason` optional.
`axme tasks submit <id>`	Submit a structured form response. `--data-json`.
Scenarios
`axme scenarios list-templates`	List available scenario templates.
`axme scenarios create`	Create a scenario from a template. `--template`, `--name`.
`axme scenarios validate <file>`	Validate a scenario bundle file against the schema.
`axme scenarios apply <file>`	Apply a scenario bundle — provisions agents, routing, and transport.
Agents
`axme agents list`	List registered agents in the workspace.
`axme agents show <address>`	Show details of a specific agent.
`axme agents register`	Register a new agent. `--name`, `--transport`, `--endpoint-url`.
`axme agents delete <address>`	Delete an agent registration.
`axme agents keys create <address>`	Issue a new API key for an agent.
`axme agents keys revoke <key-id>`	Revoke an agent API key.
`axme agents policy get`	Show send policy for an agent address.
`axme agents policy set`	Set send policy. `--mode allow\|deny`, `--targets`.
`axme agents receive-override get`	Show per-agent receive policy override.
`axme agents receive-override set`	Set per-agent receive exception for cross-org intents.
Cross-Org Policies
`axme org receive-policy get`	Show org-level receive policy for cross-org intents.
`axme org receive-policy set`	Set org receive policy. `--mode open\|closed\|allowlist`.
`axme org receive-policy add`	Add an org to the receive allowlist.
`axme org receive-policy remove`	Remove an org from the receive allowlist.
Service Accounts
`axme service-accounts list`	List service accounts in the active workspace.
`axme service-accounts create`	Create a service account. `--name` required.
`axme service-accounts keys create`	Issue a new API key for a service account.
`axme service-accounts keys revoke`	Revoke an API key. `--service-account-id` + `--key-id`.
Examples
`axme examples list`	List all built-in end-to-end examples with descriptions.
`axme examples run <id>`	Run a built-in example end-to-end. Provisions agents, submits intent, streams lifecycle.
`axme run <example\|file.json>`	Run a lightweight example or a local intent JSON file.
`axme init`	Scaffold example files locally. `--example approval-resume` (default).
Diagnostics
`axme doctor`	Check credentials, connectivity, context alignment, and secret storage mode.
`axme status`	Check gateway health and service status.
`axme version`	Print CLI version, commit, and build date.

Resources

Release artifacts, source, and example code:

↗CLI releases ↗CLI repository ↗Examples repository ↗Documentation ↗Security overview