CLI reference

Every customer-facing zeon command and flag, for CLI version 1.5.5.

zeon --help lists the commands; zeon <command> --help (and zeon <group> <command> --help) prints each command's options. This reference covers version 1.5.5.

PageCommands
zeon login and zeon authlogin, logout, auth status, auth login, auth logout
zeon newnew project, new skill, new workflow, new world, new canvas, new object
zeon project, init and cloneproject list, project show, project rename, project archive, init, clone
Working-tree commandsstatus, diff, commit, push, pull, log, checkout, reset
zeon syncsync
Instance commandsup, down, brief, run, wait, stop, reset-arms, answer, logs, py, snap, open, app, say, look. For using py and the REPL, see The REPL.
zeon mesh-databasemesh-database list, mesh-database show

Configuration

The CLI reads its token from, in order: the ZEON_API_TOKEN environment variable, the nearest .env file in the current directory or a parent directory, and ~/.zeon/.env. See Signing in.

VariableMeaning
ZEON_API_TOKENThe API token. Normally written by zeon login.
ZEON_APP_URLThe web app address used in links that zeon app prints. Default https://zeonsystems.app. Set it when your organization uses the app at another address. When it is set, zeon app prints the plain app link, not a login link.

Exit codes

Project and sync commands exit with 0 on success and 1 on an error. The instance commands use a wider set; see Instance commands.


Did this page help you?