Skip to main content

Command Reference

All Citadel CLI commands organized by category. Run citadel <command> --help for full flag documentation, or man citadel-<command> if man pages are installed.

Interactive Mode​

Running citadel with no subcommand launches the interactive control center. This is the recommended way to use Citadel -- it handles login, network connection, service management, and job processing in a single unified TUI.

citadel

Setup and Provisioning​

CommandDescriptionKey Flags
citadel initJoin the AceTeam Network and optionally provision the system--authkey, --provision, --service, --node-name, --verbose
citadel loginAuthenticate with the AceTeam Network interactively--nexus, --auth-service
citadel logoutDisconnect from the AceTeam Network and clear state

Operation​

CommandDescriptionKey Flags
citadel workStart the worker (process jobs from the queue)--redis-url, --queue, --status-port, --terminal, --terminal-port, --egress-relay
citadel run [service]Start services from the manifest (or a specific service)--restart
citadel stop [service]Stop running services (or a specific service)
citadel statusDisplay the node health dashboard
citadel logs <service>Stream logs from a service-f (follow)
citadel testRun diagnostic tests against a service--service

Networking​

CommandDescriptionKey Flags
citadel nodesList all nodes on the AceTeam Network--nexus
citadel peersDiscover nodes and their capabilities
citadel call <node> <endpoint>Make an HTTP call to a peer node
citadel ping <node>Check if a peer node is reachable
citadel ssh <node>SSH into a peer node via the mesh network
citadel proxy [local-port] [peer:port]Forward a local port to a service on another node--bind, --max-conns, -v/--verbose
citadel socks [port]Run a local SOCKS5 proxy that dials out over the AceTeam Network--bind, --auth, --max-conns, -v/--verbose
citadel expose <name>Expose a local service to other nodes on the network
citadel unexpose <name>Stop exposing a previously exposed service
citadel upPut the whole machine on the network (not just this process)--check
citadel downTake the machine back off the network

See Networking and Machine-Wide Network Mode for details.

Egress Relay​

Lets another citadel node tunnel its outbound traffic through this node's own internet connection ("your exit, your IP"). Off by default, mesh-only, same-org verified peers only.

CommandDescriptionKey Flags
citadel egress-relay statusShow the current egress-relay configuration
citadel egress-relay enableEnable the relay (takes effect on the next citadel work start)
citadel egress-relay disableDisable the relay (takes effect on the next citadel work start)
citadel egress-relay allow-lan <on|off>Allow (or deny) the relay from CONNECTing into this node's own LAN/mesh
citadel egress-relay serveRun this node as a pure egress relay -- no worker, no Redis -- until interrupted

See Egress Relay for full setup instructions and the security model.

Model Serving Across the Fleet​

CommandDescriptionKey Flags
citadel mesh modelsList models served by other nodes on the network--json, --port
citadel mesh chat [prompt]Send a one-shot chat request to a model on another node--model, --node

See Model Serving & Mesh Chat for details.

Modules and Catalog Services​

A "module" is any service Citadel installs and manages by name -- a built-in engine (vllm, bonsai, ...) or a third-party catalog service.

CommandDescriptionKey Flags
citadel module install <source>Install a module from the catalog or a git source
citadel module update [name]Update an installed module
citadel module listList installed modules
citadel module info <source>Show details for a catalog module
citadel module start|stop|restart <name>Recover a single stopped/crashed module without touching its siblings--dry-run, --expect-node
citadel module search [query]Search the module catalog
citadel module reservations listList active GPU reservations held by exclusive runs
citadel module reservations release <jobID>Manually release a stuck GPU reservation

Identity, Diagnostics, and AI Tool Access​

CommandDescriptionKey Flags
citadel whoamiShow this node's identity (name, network address, platform node ID)--json
citadel servicesShow usage/idle status and footprint for every managed service
citadel service diagnose <name>Inspect a service's container and tail its logs
citadel pairing-codeRead back a pending on-node access pairing code--json
citadel mcpBridge this node's tools to an MCP-compatible AI assistant

citadel mcp lets an AI coding assistant manage this node directly. Run citadel init once, then claude mcp add aceteam -- citadel mcp (or the equivalent for your MCP client) to let an AI agent manage nodes, deploy models, and run inference on your own hardware.

Trust Receipts​

CommandDescriptionKey Flags
citadel aep verify <receipt.json>Verify the ECDSA signature of a signed AEP (Agentic Execution Protocol) receipt, entirely offline--json, --pubkey, --cert, --show-canonical

See Trust Receipts & Grounding Checks for the full receipt format and how signing is enabled.

Update​

CommandDescription
citadel update checkCheck if a new version is available
citadel update installDownload and install the latest version
citadel update statusShow current update state and version info
citadel update rollbackRoll back to the previous version
citadel update enableEnable automatic daily updates
citadel update disableDisable automatic updates

Service Management​

CommandDescription
citadel service installInstall Citadel as a system service
citadel service uninstallRemove the system service
citadel service startStart the system service
citadel service stopStop the system service
citadel service statusCheck the system service status

Other​

CommandDescriptionKey Flags
citadel versionPrint the CLI version
citadel terminal-serverStart a standalone WebSocket terminal server--port, --test

Global Flags​

These flags are available on all commands:

FlagDescription
--helpShow help for any command
--nexus <url>Override the coordination server URL (default: https://nexus.aceteam.ai)
--auth-service <url>Override the auth service URL (default: https://aceteam.ai)
--node-dir <path>Point a command at a specific node directory instead of the default location. Also settable via CITADEL_NODE_DIR. Useful for scripts and automation that manage more than one node config from a single machine.