Present
The commands that show a model: animations, the product's screens, the Arche app and stories.
Commands: archec animation · archec ui · archec app · archec story
| Command | What it does |
|---|---|
archec animation list [category] [--json] |
Arche's animation templates — the ones its editor offers — by category: flows, timing, state machines, signals, hardware, mission, comms… animation v-x "…" from <template> { … } starts from one (animations). |
archec animation show <template> |
What a template draws, each piece of data it reads (its shape, what it means, its sample), what it can take from the model (machine, scenario), and a starter block. |
archec animation new <template> <id> [--label "…"] [--into file.arche] |
A starter animation block, its data the template's sample written in the language; printed, or added to a file. |
archec animation preview <main.arche> [id] [-o page.html] [--open] |
A page that plays the animation (each one, without an id) in a sandboxed frame, as a slide shows it — its ${…} worked out against the constants and parameters, light or dark. Default folder: arche-out/animations. |
archec ui <main.arche> [--json] [--id <component>] |
The product's user interface as archec resolves it (ui): each ui's device and theme, its screens and, element by element, what it is bound to (with its type and unit), what a press does, where the screens lead, the names it reads. --json prints the model itself (UiModel, src/ui.ts) — what a preview, a simulator or a code generator reads; the build writes the same to ui/<component>.json. |
archec ui preview <main.arche> [--screen S] [--id <component>] [-o screens.html] [--png screens.png] [--chrome path] |
The screens drawn (ui): one self-contained page with every screen and dialog of each ui (or --screen S), the overlays over them, each element showing a sample value — the model's own first values (each part's variables and state at the start of a run of the browser simulator), its constants, and for a message not received yet a value within its type's range. A click on an element says what it is, what it reads and does, and the file and line it is written on. -o names the page (screens.html by default); --png also takes a picture of them by headless Chrome (--chrome, $CHROME, else the usual places). archec doc --html shows the same screens as figures. |
archec ui snapshot <main.arche> [--update] [--screen S] [--id <component>] [--tolerance 0.1] [-o <diff dir>] [--chrome path] |
Golden screenshots (ui): each screen and dialog drawn by headless Chrome, as archec ui preview --png draws it, and compared pixel by pixel with ui/screenshots/<ui>/<screen>.png beside the main file; --update writes them. A screen with more than --tolerance percent of its pixels changed (0.1 by default; a channel within 24 of the golden is the same) fails, its diff written to -o (arche-out/.archec/ui-diff/<ui>/<screen>.png: the golden faded, what changed in red, and <screen>.now.png). Without Chrome it says so and compares nothing (exit 0). Exit 1 when a screen differs or has no golden. |
archec story list <main.arche> |
The stories, and how many steps each has. |
archec story export <main.arche> [story] [-o story.html] [--lang en] [--open] |
A story as one HTML file, for someone with no Arche: its steps in order, their text in the language asked (a translation, else as written), the animations they play running in sandboxed frames with their data worked out, the pictures, and a step on a system (its canvas, or its file) that system's block diagram; what only the app shows is named (In Arche: the memory map · KRIA260.yaml). Arrows, Home/End, n notes, f full screen; p (or #play in the address) plays it by itself, each step for its dwell (8 s without). Nothing is fetched. Default: arche-out/<story>.html. |
archec story export <main.arche> --tries [dir] [--run id] [--scenario TP/TC] [--task "…"] [-o reel.html|reel.gif|reel.webm] [--seconds s] [--width px] [--fps n] [--theme dark] [--chrome path] |
A tuning run's tries (tuning, .arche/tries/, the newest run without --run) as a reel (watching the tries): a title card with the task, each try replayed in 3D from its poses with its verdicts over it, the last try, an end card. .html plays it (and every try can be scrubbed); .gif (frame by frame) or .webm (real time) records it in headless Chrome. Default: arche-out/<run>.html. |
archec animation render <main.arche> [id] [-o out.gif|dir] [--theme dark] [--seconds s] [--fps n] [--width px] [--chrome path] |
A GIF of the animation, recorded the way Arche's .pptx export records one (its own frames, painted by the drawing), in headless Chrome or Chromium (--chrome, $CHROME, or the usual places); one cycle of its duration (3 s without) at its fps (10). |
archec app [main.arche] [--port 8080] [--host 127.0.0.1] [--static <dir>] [--allow-python] [--allow-build] [--token <t>] [--source-index] |
The Arche app (the visual editor) on the project's .arche sources (app): every YAML file it reads built from them, every save written back into them — checked by building the sources again before anything is written. In VS Code: Arche: Open Arche App. |