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 CLI ships with single-letter aliases for the verbs you use most. Aliases compose: xpanderx, agenta, then a single letter for the action.
# Full
xpander agent new

# Short
x a n

Authentication

ShortcutFull command
x lxpander login
x cxpander configure

Top-level lifecycle (apply to active agent or to [agent])

These exist as both top-level shortcuts and agent subcommands. The forms are equivalent: the top-level form is shorter.
ShortcutFullEquivalent
x d [agent]xpander deployxpander agent deploy (agent d)
x i [agent]xpander initializexpander agent init (agent i)
xpander dev [agent]xpander agent dev
xpander logs [agent]xpander agent logs (agent l)
xpander restart [agent]xpander agent restart
xpander stop [agent]xpander agent stop
xpander invoke [agent] "msg"xpander agent invoke

Agent namespace

ShortcutFull command
x axpander agent
x a nxpander agent new
x a g <agent>xpander agent get
x a i [agent]xpander agent init
x a o [agent]xpander agent edit (or agent open)
x a del [agent]xpander agent delete
x a invoke [agent] "msg"xpander agent invoke
x a d [agent]xpander agent deploy
x a l [agent]xpander agent logs

Common chains

x a d my-agent              # deploy
x a invoke my-agent "test"  # test the deployed change
x a l my-agent              # tail logs
x a n                       # create new agent (interactive)
x a i                       # scaffold its files locally
x a d                       # deploy
When [agent] is omitted, the CLI shows an interactive selection list: handy when you only have one or two agents in a profile, or use --no-interactive to fail instead of prompting.

Global flags (work with every shortcut)

FlagDescription
-v, --versionPrint version.
--profile <n>Use a specific profile.
--api-key <key>Override API key for this command.
--output <fmt>json or table.
-y, --yesAuto-approve prompts.
--no-interactiveDisable interactive prompts (fail if input is needed).
-h, --helpShow help for the current command.
These compose with shortcuts:
x a list --json --profile staging
x a d --confirm --no-interactive