Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xpander.ai/llms.txt

Use this file to discover all available pages before exploring further.

The xpander CLI is your command-line for managing agents, scaffolding local projects, and deploying containers to xpander.ai’s cloud. It covers four areas:
AreaWhat it does
Control planeCreate, edit, delete, invoke agents in the cloud.
Local developmentScaffold framework templates and run agents locally.
Cloud deploymentBuild and deploy Docker containers, stream logs, restart, stop.
NeMo syncPull/push agent model configuration to/from local NeMo config.

Install

Requirements: Node.js 20+, Python 3.12+.
npm install -g xpander-cli
Verify the install:
xpander --version
Authenticate (opens a browser):
xpander login
Or set credentials manually:
xpander configure
Credentials are stored at ~/.xpander/credentials and scoped per profile (default profile is default).

First command

xpander agent new
The wizard prompts for a name, creates the agent in your org, and offers to load the framework template into the current directory.

Global options

These apply to every command (and to xpander itself):
FlagDescription
-v, --versionPrint the CLI version and exit.
--output <format>Output format: json or table. Defaults to table.
--profile <n>Profile to use. Falls back to the active profile.
--api-key <key>Override the active profile’s API key for this command.
-y, --yesAuto-answer β€œyes” to every prompt (non-interactive mode).
--no-interactiveDisable interactive prompts. Commands fail if a required input is missing rather than prompting.
-h, --helpPrint help for the current command.

Top-level commands

CommandAliasPurpose
xpander configurecSet up API credentials.
xpander loginlAuthenticate via browser.
xpander profile–Manage profiles.
xpander agentaManage agents (full namespace: see Agent Commands).
xpander deploy [agent]dShortcut for agent deploy.
xpander restart [agent]–Shortcut for agent restart.
xpander stop [agent]–Shortcut for agent stop.
xpander initialize [agent]iShortcut for agent init.
xpander dev [agent]–Shortcut for agent dev.
xpander logs [agent]–Shortcut for agent logs.
xpander invoke [agent] [msg]–Shortcut for agent invoke.
xpander secrets-sync–Sync local .env to deployed agent.
xpander nemo–Sync agent model config with local NeMo config (pull / push).
xpander help [command]–Print help for a command.
Most lifecycle commands exist both as top-level shortcuts (xpander deploy) and inside the agent namespace (xpander agent deploy). Both forms are documented in Agent Commands.

Where to next

Agent Commands

Every command under xpander agent: control plane, local dev, deployment, graph, tools, NeMo.

Auth & Config

login, configure, profile, secrets-sync.

Shortcuts

x a n, x a d, and friends.