File reference

What a Zeon project looks like on disk, and which page documents each file.

A project is a folder of plain text files. The CLI, the web IDE, and the sync service all read and write the same layout, so anything you see in one place exists as a file you can open in another.

my-project/
├── project.json
├── skills/
│   └── <skill_id>/
│       ├── metadata.yaml
│       └── robotic_code.py
├── workflows/
│   └── <workflow_id>.json
├── worlds/
│   └── <world_id>/
│       └── world_state.json
├── objects/
│   └── <object_name>/
│       ├── <object_name>.urdf
│       └── <object_name>.object_model.yaml
└── canvas/
    └── <workflow_id>_screen.tsx

Item names are lowercase, start with a letter or underscore, and may contain letters, digits, underscores, and hyphens, up to 64 characters.

FileWhat it holdsReference
project.jsonProject manifest and the active workflow and world pointersProject.json
skills/<id>/metadata.yamlSkill id, parameters, preconditions, postconditionsSkill metadata.yaml
workflows/<id>.jsonThe workflow graph: nodes, edges, inputsWorkflow JSON
worlds/<id>/world_state.jsonScene contents and simulation configWorld state JSON
objects/<name>/<name>.object_model.yamlParts, articulations, and anchors for one objectObject model YAML
📝

These pages describe files the tools write for you. Creating items through the CLI or the IDE produces valid files, and the editors keep them valid as you work. Read these pages to understand a file you are looking at, to review a change before you sync, or to fix something a tool cannot express. Hand editing is the exception, not the normal path.

Skills also carry Python that runs on the robot. For how that code is structured, see Authoring a skill.


Did this page help you?