Documentation

FFremote CLI

The FFremote CLI (Command Line Interface) allows you to run FFMpeg jobs on a remote server. The CLI has a number of commands that can be used to perform different tasks, check the links below for more information on each command.

Visit the Getting Started Guide to learn how to install CLI.

Commands

execute

Execute an FFmpeg command on the remote server


# Usage
ffremote execute [options] -- <ffmpeg-args>...
ffremote [options] -- <ffmpeg-args>...
ffremote <ffmpeg-args>...
# Examples
ffremote execute -- -i "test.mov" -t 30 -c:v libx264 -c:a aac -strict experimental "test.mp4"
ffremote --size=lg -- -i "test.mov" -t 30 -c:v libx264 -c:a aac -strict experimental "test.mp4"
ffremote -i "test.mov" -t 30 -c:v libx264 -c:a aac -strict experimental "test.mp4"

Options

--size=<size>

Size of the remote instance to use. View available values

--include=<include>

Files to upload to the remote server that aren't used as input (-i). You can specify multiple files by repeating the option.

--exclude=<exclude>

Files to exclude from the final output archive. Input files are automatically excluded from the output. You can specify multiple files by repeating the option. Glob paths are also supported.

list

List all executions


# Usage
ffremote list

watch

Watch the execution of a command


# Usage
ffremote watch [id]
# Examples
ffremote watch 0bb4dce9-1751-4aaa-9b26-fadca6642680
ffremote watch # use last id or prompt

get

Download the output of a command


# Usage
ffremote get [id]
# Examples
ffremote get 0bb4dce9-1751-4aaa-9b26-fadca6642680
ffremote get # use last id or prompt

status

Get the status of a command


# Usage
ffremote status [id]
# Examples
ffremote status 0bb4dce9-1751-4aaa-9b26-fadca6642680
ffremote status # use last id or prompt

auth

Authenticate with the remote server


# Usage
ffremote auth [subcommand]
# Examples
ffremote auth
ffremote auth logout
ffremote auth refresh