vossodocs
Open studio
  • Overview
  • With your agent
  • What is vosso
  • Make your first video
  • Keyboard shortcuts

Studio

    • Install the recorder
    • Record a tab
    • Record a window or the screen
    • Webcam and microphone
    • Tab and system audio
    • Take a screenshot
    • Record without the extension
    • Bring a video file
    • Record with the CLI
    • Record a desktop app
    • Zooms
    • Adjust a zoom
    • Add and delete zooms
    • Camera styles
    • Follow the cursor
    • Tilt
    • Cursor and clicks
    • Trim and split
    • Speed
    • Freeze
    • Range chips
    • Add footage and transitions
    • Text
    • Media
    • Reuse a file
    • HTML layers
    • Live layers
    • Soundtrack
    • Voice and levels
    • Backdrop
    • Card and frame
    • Webcam
    • History
    • Save and autosave
    • Projects and recipes
    • Files
    • Export a video
    • The program itself
    • Publish
    • The watch page
    • Embed a vos
    • Remix and duplicate
    • Every release

Agents and code

    • The agent contract
    • Install the skills
    • What your agent does on your machine
    • Bring a Remotion or HyperFrames video
    • Push and pull
    • Versions and conflicts
    • Folders and recipes
    • Credentials
  • Start

    • Install and log in
    • The take directory

    Reference

    • Verbs
    • actions.json
    • doc.json
    • HTML layers
  • Programs

    • Overview and auth
    • Config format
    • Voses and versions

    Catalogs

    • Fonts
    • Music and SFX
    • 3D typefaces
    • Backdrops
    • Limits
Back to vos.so

CLI › Reference

Verbs

Every vos command, from the one-shot create to the hosted push and pull.

previous← The take directorynextactions.json →

Every vos command, at reference altitude. The take verbs work on a take directory; the platform verbs talk to vos.so. Full flag detail lives in vos <verb> --help and the complete agent reference at /llms-full.txt.

The take pipeline

VerbWhat it does
vos look https://your.appSee the page before you script it: look.png and every control in view with one proposed selector, counted UNIQUE or AMBIGUOUS by the recorder's own engine. Takes the session flags record takes, and --click walks it to the next screen; a click on something that spends or destroys is refused
vos create --actions actions.json out.webm --strictThe one-shot: record, auto-plan and render in one browser session. The take dir still lands on disk, so the loop stays open
vos record --actions actions.json --out take --strictDrive the page, synthesize the cursor track, encode, auto-plan zooms. Recording is real time. --hosted records on vos.so instead, for a machine with no browser: a public URL (or a preview behind --header) lands as a private vos with its doc and digest and comes home with its media; a session never travels
vos record --app TextEdit --out takeA desktop app's window on macOS, recorded as you or your agent work it. There is no script: Ctrl-C ends the take, or --seconds. The window is recorded alone, with no system pointer in its pixels, and the pointer's path, presses and typing are in cursor.json, so the take is planned like a page take. --windows lists what can be recorded. It needs Screen Recording for the app the CLI runs from, and vos doctor says whether it has it
vos look --app CalculatorSee a desktop app's window before you script it: look.png and every control with one proposed selector (button[name='Save'], textfield[id='title']), UNIQUE or AMBIGUOUS. Nothing is pressed, and what was typed into a field is never read. With --actions actions.json --until <step id> it runs the script to that step, for real, and looks at the screen it opens. An Electron or Chromium app shows its controls only once it has built its accessibility tree: start it with --force-renderer-accessibility. It needs Accessibility as well as Screen Recording
vos record --app Calculator --actions actions.json --out take --strictThe same window, scripted: the actions.json a page's take runs drives the app through accessibility. The app comes to the front and the real pointer and keyboard are used, so leave the machine alone until it ends; there is no --dry-run. A page's fields and steps (url, mask, setup, await, paste, download) are refused in words. It stops at the first step that misses, so no later key lands where the script did not mean, and it refuses to type onto a row or a button. --pid <n> names one process's window: film a throwaway instance of the app, never the one someone has open with real work. The take keeps its script and its steps
vos plan takeRe-plan auto zooms from the cursor track. source:"manual" spans are preserved; --fresh discards the doc. --reuse re-times a previous cut onto a re-recording of the same script and names whatever could not follow. --zooms per-beat keeps at most one zoom per captioned beat, on the steps the script marks "zoom": true
vos frames take --at-zoomsPNG stills from the composed take: contact sheet plus every zoom apex on every media, each checked against the same frame with the zooms off, so a zoom that did not render is said. This is how you look at your work
vos render take out.webmDeterministic render. --range a..b --draft spot-checks an edit in seconds; never ship a draft. A range render keeps its audio
vos check-video take/out.webmThe rendered file itself: duration, codecs, size and frame rate, full-frame scene changes, loudness, and the first and last frames, with a warning for a cut that jumps (a hard cut between two light, sparse pictures included), a track that is too quiet or too loud, and an empty open or close
vos join intro-take settings-take --out filmSeveral takes, or plain video files, cut into one take in argument order: each becomes a media of one document you edit, render and push like any other. --captions lands every step's caption, anchored to its step and starting as it begins. --keep-edits joins again over the edited film and keeps its cut: inputs are matched by source file, and a re-recorded one keeps its edits re-timed by its steps
vos info takeThe take's two clocks: every step with its source seconds and where it plays in the cut, then each segment, span, layer, sound clip, the still and the end on the output timeline. It writes nothing
vos score film --track <slug> --at <step>One music clip whose strongest swell lands on that step (or a second), read from the track's loudness, played to a -16 LUFS target (--normalize <lufs>, or off); --dry-run prints the plan and writes nothing
vos audio measure takeEvery audio clip's loudness (integrated LUFS and sample peak) written beside it in doc.json: the fact a clip's normalize target plays it to
vos deliver take --to youtube,x,githubThe release's video in one pass: the demo, the feed cut, the vertical cut and the README loop, each rendered and verified against its channel spec, plus the kit.json manifest. Misses land in skipped with the reason
vos brand https://your.appYour brand as a BRAND.md recipe, witnessed: /design.md when you publish one, /llms.txt for the name, then the page (ground, surfaces, faces, inks, the accent buttons and links agree on, icons, og:image), with where each value came from and the site's own avoid list
vos validate take/kit/kit.jsonRe-measures every cut from its bytes against the channel specs: a container that is not what its name says, a size or duration the manifest lies about, a byte ceiling. --picture adds each video's first and last frames
vos open takeServe the take into the studio; the document arrives intact and every span is draggable
vos ingest video.webm --cursor trace.zip --out takeA take from a recording someone else made: the file becomes recording.<container>, its own dimensions and length become meta.json, and a trace beside it (a Playwright trace.zip, stamped JSON records, a t,x,y,type CSV) becomes the cursor track the plan zooms on. Without a trace nothing is planned, and the done event says so. The studio reads the same traces when both files are dropped together
vos actions from-agent-browser steps.jsonlThe walk an agent made in agent-browser (each command kept beside its --json result, the batch record shape) becomes actions.json: refs resolve through the last snapshot to role and name selectors, CSS passes through, and every step the recorder cannot follow is named, never dropped
vos validate <actions.json or take>Structural check for a script; semantic lints for a take's doc. Must pass before you render

Always pass --strict to record (and create): a skipped step (a selector that never appeared, an expect that never held, a download that never came), a click on a disabled control or an await that timed out exits 2 with a machine-readable skipped[] list. A skip is a broken flow; fix the selector and re-record, never ship around it. A take starts once the first page has stopped changing (ready: "dom", the default; --ready networkidle is the opt-in), and a first load that never settles is only a note, since many real apps never go network-idle. Every step is bounded, so a page that stops answering ends the step as a skip.

Both take --max-duration <seconds>, default 1800: the capture stops there and says so in the done event (capped: true; with --strict that exits 2). The default is the hosted cap, 30 minutes, which vos push refuses to exceed. See Limits.

The platform verbs

VerbWhat it does
vos setupReady this machine: the skills into your agent's directories, a browser, one rules block, then doctor, ending with the list of what it changed. Takes --agent, --global, --no-skills, --no-rules, --no-browser, --url
vos setup --planWhat setup would write, without writing anything: the skills per folder, the browser command, the exact rules block
vos setup --removeTake the vos skills and the rules block back out, leaving the rest of the file as it was. Never removes a browser, the package or a sign-in. --remove --plan shows it first
vos guide | vos guide hostPrint the steps an agent follows to record a product, or to put a finished video on vos.so. The same text vos.so/agent.md and vos.so/host.md serve
vos feedback "<what happened>"Report a problem to vos.so. Prints the address and everything it sends first, sends no sign-in; --dry-run sends nothing
vos doctorWhat is ready, in words: node, browser, ffmpeg, skills, a credential (never printed), the dev server with --url. Exit 3 when no browser
vos whoamiThe account in use, its key's name, and every other account stored; never a key
vos switch [<handle>]Use another stored account (with two stored, the other one)
vos logout [<handle>] [--all]Forget the account in use, a named one, or every stored credential
vos loginBrowser sign-in; stores a content key itself. See Install and log in
vos fetch <id or watch-url>A program's config.json plus tracking; public voses need no auth. --media brings its declared files home under assets/
vos check config.jsonFull local validation: migrate, schema, compile, determinism, font and declared-file lints
vos push <take or config.json>Host work as a private vos or a new version. Polymorphic by sniff: a take dir routes through the take pipeline. On create, --desc, --tags and --folder <folder> describe and file the vos in one call. Every local file the program names is uploaded. --prompt <text> shows the prompt that made it on its watch page. A take that uses a document field newer than the platform renders is refused before anything uploads; --bake sends a copy with those fields baked
vos push config.json --claimableThe credential-free rung: a program and the files it names (12 files, 50 MB at most); prints a 72 hour claim link. --share makes the claim page lead with Claim and share
vos pull <take or dir>The typed changelog since your base, plus a synced document. Always pull before editing pushed work
vos folder listYour folders as a tree, with what each one holds
vos folder create <name>Add a folder; --parent <folder> nests it (5 levels max)
vos folder move <ids> --to <folder>File voses and assets into a folder; --to none unfiles. Add-only: renaming, deleting and reordering stay on vos.so
vos folder pull <folder>The folder's context package on disk: every recipe (inherited ones too), exemplar configs and take docs, each tracked so a push lands as a version
vos asset rename <id> <name.md>Rename one of your assets in place; the extension keeps matching its kind
vos recipe push <FILE.md> --folder <folder>Put a recipe on the shelf, filed into that folder. --asset <id> instead replaces one in place, same id, the displaced body kept as the prior version

The push and pull rules (attribution, stale bases, protected nodes) live in Push and pull.

Doc overrides on render and frames

Check any presentation without editing doc.json; the disk file is untouched and the patched doc is lint-gated, so a bad override fails exactly like a bad document.

Shell
vos frames take --frame 2.0 --set frame.browserBar.kind=mac-light --set tilt[0].rx=8
vos render take out.webm --frame macos --background eclipse
  • --set path=value (repeatable) patches any doc field; the value is JSON when it parses, else a string. Array indices work: --set zoom[0].level=3.
  • --frame <kind> on render sets the browser frame: macos | mac-dark | windows | windows-dark | minimal | none. On frames, --frame <t> is the still-time selector; set the frame kind there via --set frame.browserBar.kind=....
  • --background <url> adds a background media layer; kind inferred from the URL, none clears it.

What to expect (measured, M-series laptop)

Recording is real time plus a few seconds of encode. Rendering is about 1.5 times real time at 1080p, of which around 5 seconds is fixed browser and CDN startup; --parallel pays off on takes longer than about 30 seconds and is ignored when audio is present. A draft range check takes about 5 seconds; a frames sheet about 2.

Related

  • actions.json and doc.json for the two documents these verbs read and write.