Skip to content

DocsRecorder and CLI

Install the CLI

Set up the terminal recorder and learn its commands.

Install the terminal recorder

The Vidova CLI records your screen, saves portable tapes, and uploads recordings to a Vidova project. Install it with Node.js 20 or newer and npm:

npm install -g @vidova/cli
vidova --version
vidova --help

The published CLI includes native packages for macOS on Apple Silicon or Intel and Windows x64. The examples here were captured with CLI 3.0.2 on macOS. Linux requires the separate source-build setup; do not assume the npm install includes a Linux recorder binary.

Vidova CLI help lists recording options and commands for authentication, projects, uploads, tapes, configuration, and devices.

Use --help to check the commands and flags in your installed CLI. This capture uses version 3.0.2.

Select the image to open the original full view.

Choose the command for the job

CommandPurpose
vidova or vidova recordOpen interactive recording setup.
vidova devicesList available displays, windows, microphones, audio devices, and cameras.
vidova permissionsCheck and request recording permissions.
vidova configShow or change recording defaults.
vidova login, whoami, logoutManage this terminal’s account connection.
vidova projectsList, create, and choose an upload project.
vidova uploadSend a recording to a project.
vidova pack, info, extractCreate, inspect, and unpack tape files.

Add --help to a command for its options. Start with Record from the terminal, then use CLI sign-in and uploads when you want to send the result to the web editor.

Save your preferred capture settings

vidova config
vidova config fps 30
vidova config width 1920
vidova config countdown 3
vidova config no-keyboard true

The built-in defaults are 60 fps, a 1920-pixel recording width, and no countdown. You can also set raw, no-cursor, and output-dir. Set a Boolean option to false to turn that saved option off. Use vidova config --reset to clear all custom recording defaults.

Explicit frame rate, width, and countdown flags override the saved values for that command. With no output path configured, recordings go to ~/.vidova/recordings/. VIDOVA_HOME selects a different CLI data directory, including its configuration and sign-in state.

Vidova config lists available recording defaults and their built-in values.

No custom defaults are saved in this isolated demo profile. Set individual values or reset all custom defaults.

Select the image to open the original full view.

Connect an agent separately

The CLI is for recording and file delivery. To let an external AI client edit a Vidova project, connect the remote MCP server using https://mcp.vidova.ai/mcp. Installing the CLI does not connect an MCP client.