VCursor CLI

The command-line interface is the fastest way to interact with VCursor. Generate videos, manage configuration, and troubleshoot issues directly from your terminal.

Installation

bash

curl -fsSL https://cli.vcursor.com/install.sh | bash

The installer automatically detects your operating system (macOS, Linux, Windows w/ WSL) and installs necessary dependencies.

Authentication

bash

vcursor login

Note: You can also set the VCURSOR_API_KEY environment variable for CI/CD environments.

Common Usage

The CLI uses smart detection to handle inputs. Simply pass text, files, or URLs in any order.

Text to Video

Generate videos from detailed text descriptions.

bash

vcursor "cinematic drone shot"

Image to Video

Bring static images to life with motion.

bash

vcursor ./image.jpg "animate water"

Agent Mode

Use "Agent Mode" for complex, multi-step tasks. The agent will plan, generate assets (images, audio), and edit them together into a final video.

bash

vcursor --agent "create a 30s coffee commercial"

Command Reference

Comprehensive guide to all available flags and options.

Core & Workflow

--agent

Use autonomous agent mode for complex tasks like video editing.

Ex:--agent "make a modal"

--plan

Preview the execution plan without running it.

Ex:--plan "my prompt"

--ask

Chat with VCursor about technical questions or help.

Ex:--ask "how do I animate?"

--mode <name>

Force a specific generation mode (e.g., text2video, image2video).

Ex:--mode image2video

-o, --output

Specify the output file path.

Ex:-o ./result.mp4

--open

Automatically open the file after generation.

Ex:--open

--json

Output results in JSON format for scripting.

Ex:--json

Video Settings

--duration

Target duration for the video.

Ex:--duration "5s"

--aspectRatio

Video aspect ratio.

Ex:--aspectRatio "16:9"

--resolution

Output resolution.

Ex:--resolution "1080p"

--model

Specific AI model to use.

Ex:--model "stable-video"

Audio & Style

--voiceover

Add AI voiceover text.

Ex:--voiceover "Hello world"

--subtitles

Generate subtitles for the video.

Ex:--subtitles

--bgm

Add background music description.

Ex:--bgm "upbeat lofi"

--soundEffects

Add sound effects description.

Ex:--soundEffects "explosions"

--visualStyle

Define a specific visual style.

Ex:--visualStyle "cyberpunk"