Command reference
The full top-level surface. Every command takes --base to point at a deployment and --json to emit machine-readable output on stdout.
Working surfaces
| Command | What it does |
|---|---|
board | Annotation boards. |
set | Screenshot and artifact sets. |
artifact | Self-contained interactive pages. |
diagram | Refreshable architecture diagrams. |
work | The annotation work queue. |
tag | The tag vocabulary — the third axis beside project and subgroup. |
Session and machine
| Command | What it does |
|---|---|
status | Session dashboard: live board, open work queue, and listener lease. |
open | Open the thing you're working on — the set's live board, or vitrinka home. |
ui | Open the dashboard. Running vitrinka bare on a terminal does the same. |
edit | Open a file or project in the Vitrinka editor. |
config | This machine's vitrinka settings. |
auth | Credentials, one per deployment. |
project | This repository's vitrinka wiring. |
tidy | Sweep legacy roots and stray shots into .vitrinka/. |
Setup and administration
| Command | What it does |
|---|---|
install / uninstall / update | Onboard, remove, or refresh every installed surface. |
doctor | Check this machine's setup and name the repair for each failure. |
extension | Install, update and diagnose the recorder extension. |
admin | Deployment administration — currently the mailer (admin smtp). |
completion | Generate the shell autocompletion script. |
ai | Ask for a vitrinka command in plain words. |
Publishing without the CLI
Nothing about publishing requires the CLI. A tar pipe publishes a whole set from any job you already run — no SDK to install, nothing to keep up to date in the pipeline.
tar czf - ./shots | curl -sS -X POST \
-H "Authorization: Bearer $VITRINKA_TOKEN" \
--data-binary @- "$VITRINKA_URL/api/v1/sets?name=nightly"MAX_SET_MB (default 200) caps both the request body and the unpacked size of a single set.