CLI cheat sheet

The zeon commands you use every day, on one page.

Run project commands inside the project folder (or any folder below it). Every command has --help.

Account

CommandWhat it does
zeon loginSign in through the browser and store an API token in ~/.zeon/.env.
zeon auth statusShow the active credentials and check them with the server.
zeon logoutSign out: end the browser sessions from this machine's login links, revoke a token from a browser zeon login, remove the stored token.

Projects

CommandWhat it does
zeon new project NAMECreate a cloud project from the starter and a working tree in ./NAME/.
zeon new project NAME --template emptyThe same, with no files.
zeon clone PROJECT [DIR]Get a working tree of an existing cloud project (id or name).
zeon initLink the current folder to a new cloud project, named by "name" in its project.json, and push its files.
zeon project listList your projects.
zeon new skill NAMEAdd a skill. Also workflow, world, canvas WORKFLOW_ID, object TYPE.

Sync

CommandWhat it does
zeon statusFiles added, modified, deleted or unmerged since the last commit.
zeon diff [PATH...]Line diff of your changes.
zeon commit -m "MESSAGE" [PATH...]Record a local commit.
zeon syncCommit pending changes, merge the cloud's changes, push, refresh your instance.
zeon sync --continue / --abortFinish or cancel a sync that stopped on a conflict.
zeon pushSend local commits to the cloud.
zeon pullBring the cloud's changes into a clean working tree.
zeon logRecent commits.

The cloud instance and runs

CommandWhat it does
zeon upLoad the pushed project and its active world on your instance; print the viewer link.
zeon up --world WThe same, loading world W.
zeon run NAME -i key=valueRun a skill or workflow in the simulation and wait, Fast at 8x. --detach returns at once. Unknown names, unknown or missing inputs and values of the wrong type are refused before the run starts.
zeon run NAME --speed 2A Fast run played back at 1x, 2x, 4x or 8x.
zeon run NAME --motion full --detachThe robot's own control loops, in real time. Run once before the real robot.
zeon wait IDWait for a run to finish.
zeon stop IDStop a run, as Stop in the app does. A stopped run does not resume.
zeon reset-armsPut both simulated arms back at their start position, grippers open, after a run that stopped half-way. Objects stay where they are.
zeon answer ID [CHOICE]Answer a run's ask_user_slack prompt. Without CHOICE: show the question and its options.
zeon logs ID -fPrint a run's log and follow it to the end.
zeon app WOpen the web app signed in, on workflow W's canvas beside the simulation. --run: its run screen; no W: the project. A personal link: once, within 5 minutes; do not share it.
zeon downRelease your instance and end the browser sessions from your login links.

The REPL

The main way to try things on your instance. These use the instance's REPL, which Zeon enables per account (see The REPL).

CommandWhat it does
zeon briefProject, setup, world and objects, the arms, skills, workflows, recent runs.
zeon py 'CODE' / zeon py -f FILERun Python in the instance's simulation REPL. Names you define stay for the next entry.
zeon snap out.pngSave a picture of the simulation viewer. Without a path: .zeon/snaps/ in the project folder.
zeon openPrint the 3D viewer link, the view to share (no sign-in needed).
zeon say "TEXT"Post a message to the viewer's Agent panel.
zeon look TARGETPoint the viewer camera at an object, an anchor or a preset.

Every instance command takes --json. Exit codes: 0 ok, 1 failed, 2 usage, 3 not signed in or not enabled, 4 refused by the REPL guard, 5 timed out, 6 instance unavailable.


Did this page help you?