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
1curl -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
Log in with your API key to access paid features and higher rate limits.
1$ 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.
1$ vcursor "cinematic drone shot"
Image to Video
Bring static images to life with motion.
1$ 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.
1$ vcursor --agent "create a 30s coffee commercial"
Command Reference
| Flag | Description | Example |
|---|---|---|
--agent | Use autonomous agent mode for complex tasks. | --agent "make a modal" |
--mode <name> | Force a specific generation mode. | --mode image2video |
--plan | Preview the execution plan without running it. | --plan "my prompt" |
-o, --output | Specify the output file path. | -o ./result.mp4 |