doctor | --json, --rules | Checks the machine. Exits non-zero when a check fails. --json always exits 0, so read .ok. --rules prints the variation and compliance checklists. |
tick | --now, --about "SUBJECT", --script FILE, --script-template, --duration RANGE, --json, --dry-run, --skip-render, --engine ENGINE_ID | Runs the pipeline once. --now makes a video now. --about makes a one-off video about a subject and skips the feed. --script FILE passes an agent-written script and implies --now. With --json, each job has engage = {status, code}, the engine that rendered, and checks. --script-template prints an example. |
worker | --dry-run, --all-projects, --once | Runs a tick every 60 seconds until stopped. --all-projects ticks every project on the machine with a due series, and logs to ~/.vfrey/logs/worker.log. --once runs one cycle. |
service | install, uninstall, status --json, logs --follow | Runs the worker in the background, with launchd on macOS or a systemd user unit on Linux. See Background worker. |
engage | --dry-run | Replies to comments on published videos. With no platform keys the summary says “Replies skipped: no platform keys”. |
analytics | --dry-run | Collects view and like counts. |
render | --subject "TEXT", --engine, --composition, --output, --scene DIR, --frame SECONDS, --script FILE | Renders one vertical 1080×1920 picture. With --scene DIR it renders your scene, or one frame with --frame. |
scene | init DIR [--script FILE], blocks, add BLOCK DIR, transitions, --engine, --category, --force, --json | Writes a starter scene, lists the scene blocks, copies one into a scene, and lists the shader transitions. |
engine | list, use ENGINE_ID, --json | Lists the render engines with status and reason. use sets the machine default. |
dashboard | --port PORT, stop | Serves the local dashboard. stop (or --stop) stops the one a tick or open started. dev and desk serve are aliases. |
push | none | Refuses for now. Publishing happens inside tick. |
update | --apply | Prints the update commands. Runs them only with --apply. |
desk | snapshot --json, series create|update|pause|resume|delete|live, job retry|cancel|delete|approve|reject --id JOB_ID, account, secret, platform, source, cadence, mode, tick, import --from FOLDER | Reads and changes the desk. |
skill | install, uninstall, --agent, --project, --dir, --force | Installs the vfrey skill for your agent. |
init | --name, --engine, --from DIR | Makes the current folder a project. |
open | RUN_ID or VIDEO, --no-browser, --json | Opens this project’s dashboard, or a run’s page. |
videos | --json, --limit N | Lists finished videos. |
projects | --json, --prune | Lists the projects on this machine. |
login, logout, whoami | --api URL, --no-browser, --json | Signs in to a vfrey account. Only paid features need one, and accounts are not live yet. whoami shows plan, credits, and usage. See Account. |
topics | --niche ID, --limit N, --since ISO, niches, request --name --keywords --hashtags --platforms, --json, --api URL | Rising topics with evidence. Needs an account and credits. See Topics. |
creators | search, show @HANDLE, watch add|remove|list, export, alerts, --platform, --niche, --followers, --posts-per-week, --engagement, --sort, --limit, --watchlist, --json, --api URL | Finds creators and studies their formats. Needs credits. See Creators. |
mail | draft, drafts, show, approve, send, discard, identity, --json, --api URL | Drafts outreach. A person approves and sends. Sending needs a paid plan or a credit top-up, and credits. See Mail. |
