Skip to main content

AlphaSwarm CLI Operator Guide

The AlphaSwarm CLI (alphaswarm-cli or alphaswarm) is the primary tool for operators and developers to interact with the AlphaSwarm platform.

Read the AlphaSwarm CLI README for installation instructions.

Command Map​

alphaswarm-cli setup     init | verify | render-config
alphaswarm-cli services  list | status <service>
alphaswarm-cli update    check | apply [--dry-run]
alphaswarm-cli auth      login | whoami | authorize | providers | refresh | logout | keys * | device * | yubikey *
alphaswarm-cli context   list | use | show | clear
alphaswarm-cli account   profile | update | change-password | delete | audit | sessions * | mfa * | connections *
alphaswarm-cli orgs      list | show | create | update | delete | teams | workspaces | members * | settings *
alphaswarm-cli users     list | show | create | update | invite | deactivate | activate | delete | memberships *
alphaswarm-cli teams     list | create | show | update | delete | members | add-member | remove-member
alphaswarm-cli projects  list | create | show | update | archive | unarchive | delete
alphaswarm-cli brokers   list | providers | venues | add | test | remove
alphaswarm-cli accounts  list | show | create | positions | balance | orders | sync | summary
alphaswarm-cli bots      list | show | create | deploy | start | stop | restart | halt | halt-all | logs | versions | deployments | backtest
alphaswarm-cli audit     list | stream
alphaswarm-cli status    system | probes | services
alphaswarm-cli config    get | set | show | diff | clear
alphaswarm-cli cp        deployments * | workloads * | cluster * | terraform * | cloudflare * | topology *
alphaswarm-cli deploy    plan | apply | up | down | refresh | status | logs | endpoints | build | publish-rpi
alphaswarm-cli viz       config | datasets | sync | export | import | render | cache-clear | datahub
alphaswarm-cli client    start | stop | status | logs | build | typecheck
alphaswarm-cli ide       install | build | start | stop | status | logs | open | url | env | detect | doctor
alphaswarm-cli tools     generate-docs | bots ... | control-plane ... | admin-api ... | helpers *

Where State Lives​

File / dirPurpose
~/.config/alphaswarm/credentials/auth-session.jsonCached access/refresh/id tokens for CLI auth sessions.
OS keyring entry alphaswarm-cliTokens + M2M service-account profiles.
~/.config/alphaswarm/context.jsonActive tenant context (org / project), set by context use.
~/.config/alphaswarm/topology.jsonCached topology snapshot.

Tenant-Aware Operations (Multi-Tenancy)​

The CLI supports multi-tenancy by managing an active context:

  1. Discovery: alphaswarm-cli context list shows organizations and projects.
  2. Switching: alphaswarm-cli context use <org_id> [--project <id>] sets the active context.
  3. Propagation: Headers like X-AlphaSwarm-Org are automatically added to requests.
  4. Validation: Use alphaswarm-cli context show to verify effective identity.

AlphaSwarm IDE Entrypoint​

alphaswarm-cli ide is the sanctioned way to manage the AlphaSwarm Theia IDE.

alphaswarm-cli ide install
alphaswarm-cli ide build --dev
alphaswarm-cli ide start --open

Further Documentation​