Documentation

VideoConvert Docs

Learn how to use VideoConvert, from basic usage to advanced CLI automation.

Quick Start

1. Download & Install

Download VideoConvert for your platform from the downloads page.

2. Launch the App

Open VideoConvert. The web dashboard will automatically open in your browser at http://localhost:3000

3. Convert Your First Video

Drag and drop your video file or click to browse
Select your target aspect ratio (16:9, 9:16, 1:1, 4:5)
Choose transform mode (Fit, Fill, or Stretch)
Click "Convert" and wait for processing
Download your converted video

CLI Usage

Basic Syntax

vconvert <input> [options] -o <output>

Examples

vconvert input.mp4 -r 9:16 -o output.mp4

Convert video to 9:16 portrait aspect ratio

vconvert input.mp4 -r 1:1 -m fill -o output.mp4

Convert to square with fill (crop) mode

vconvert input.mp4 -f webm -q high -o output.webm

Convert to WebM with high quality

vconvert input.mp4 -r 9:16 --resolution 1080p

Convert with specific resolution

Options Reference

Flag	Value	Description
`-r, --ratio`	<ratio>	Target aspect ratio (16:9, 9:16, 1:1, 4:5)
`-m, --mode`	<mode>	Transform mode (fit, fill, stretch)
`-f, --format`	<format>	Output format (mp4, mov, mkv, avi, webm)
`-q, --quality`	<quality>	Quality preset (high, medium, low, draft)
`-o, --output`	<path>	Output file path
`--resolution`	<res>	Output resolution (4k, 1080p, 720p, 480p)
`--batch`	<dir>	Batch convert all videos in directory (Pro)
`-h, --help`		Show help

API Reference

Node.js Module

VideoConvert can be used as a Node.js module for programmatic access.

const { convert } = require('videoconvert');

// Basic conversion
await convert({
  input: 'input.mp4',
  output: 'output.mp4',
  ratio: '9:16',
  mode: 'fit',
  format: 'mp4',
  quality: 'high'
});

// With progress callback
await convert({
  input: 'input.mp4',
  output: 'output.mp4',
  ratio: '1:1',
  onProgress: (percent) => {
    console.log(`Progress: ${percent}%`);
  }
});

REST API (Web Dashboard)

The web dashboard exposes a REST API at localhost:3000/api.

POST/api/convert

Start a new conversion job

GET/api/status/:jobId

Get job status and progress

GET/api/download/:jobId

Download converted file

Configuration

License Activation

To activate your Pro license:

Open VideoConvert settings
Navigate to "License" tab
Enter your license key (format: VC-XXXX-XXXX-XXXX)
Click "Activate"

Your license key was sent to your email after purchase.

Troubleshooting

Video conversion fails

Ensure your input file is a valid video format. Try re-encoding with a different tool if the file is corrupted.

App won't start

Check if port 3000 is already in use. You can change the port in settings or kill the process using that port.

Output quality is poor

Try using the "high" quality preset. Note that upscaling low-resolution videos will not improve quality.

Need more help?

Check our GitHub issues or contact support.