CLI

Install Vidova CLI first. Bring native capture into AVS after.

Vidova CLI is the terminal-facing capture companion for Agentic Video Studio. It records screens and windows using native code, packages recordings into `.vidova` bundles, inspects devices and permissions, and uploads directly into AVS projects once the terminal is linked to your account.

One-key AVS upload
Native recorder

Install

Terminal

npm i -g @vidova/cli

That is the main entry point. Install the package globally, run vidova, then use the CLI for native recording, device inspection, `.vidova` packaging, and direct AVS uploads.

What it includes

The CLI is shipped as `@vidova/cli` and exposes a `vidova` binary.

Its command surface is built with Commander, while the interactive recorder runs as an Ink app.

Native media capture lives in platform-specific implementations for macOS and Windows.

Uploads target AVS through `/api/cli/*` routes, including device auth, project listing, and recording import.

Capabilities

What the CLI actually does

This is not just an upload script. The CLI exposes real capture, packaging, discovery, and auth primitives that tie directly into AVS.

01

Native recording

The CLI drives native screen capture code on macOS and Windows, with monitor or window targeting, camera and audio sources, cursor tracking, and keyboard tracking.

02

Device and permission introspection

You can list monitors, windows, microphones, cameras, and permission state from the terminal, or emit the same data as JSON for scripting.

03

.vidova packaging

Recordings can be packed into a portable `.vidova` bundle containing `manifest.json`, compressed media, and optional cursor and keyboard metadata.

04

AVS device login

The CLI uses a browser-based device authorization flow to connect the terminal to your AVS account without embedding login UI inside the recorder.

05

Project-aware uploads

Once authenticated, the CLI can list AVS projects, create projects, and upload recordings directly into the editor workflow.

06

Persistent defaults

You can set defaults for FPS, width, quality, codec, countdown, output directory, cursor tracking, keyboard tracking, and other capture behavior.

Commands

Core command surface

The CLI exposes both an interactive app-like flow and scriptable commands for recording, auth, devices, configuration, projects, and `.vidova` inspection.

01 Record

vidova

Launch the interactive Ink-based recorder UI.

02 Direct record

vidova record --window "Safari" --system-audio

Record a specific window with system audio using CLI flags.

03 Auth

vidova auth login

Open the AVS device auth flow and link the terminal to your account.

04 Devices

vidova devices --json

Enumerate monitors, windows, cameras, microphones, and permission state.

05 Defaults

vidova config quality high

Persist capture defaults locally for future runs.

06 Projects

vidova projects list

List available AVS projects for upload destinations.

07 Inspect package

vidova info ./recording.vidova

Inspect bundled metadata, files, and package structure.

08 Extract bundle

vidova extract ./recording.vidova

Unpack a `.vidova` recording into its underlying files.

Next step

Use the CLI when capture needs to start outside the editor.

It is the right surface when you want terminal-driven recording, persistent defaults, native device access, or direct import into AVS projects without bouncing through a separate desktop app flow.

Search pages

Jump to pages across Agentic Video Studio.