Getting Started

1. Installation

The install script will not add ffremote to your $PATH so you'll need to do that yourself. Here's an example of how you might add ffremote to your $PATH:

2. Start an Execution

The command will extract 48 seconds, starting at 12 second, from "bunny.mov" while adding five second audio and video fade in and out.

Before the execution is submitted, you'll be prompted to open a browser to authenticate on elwood.run. You'll also need to setup a subscription & payment method before your execution begins. Note: You will not be charged until the execution is complete.

ffremote will parse the ffmpeg args provided and upload any local files defined in -i flags. -i can also be a remote URL, as in the example above. If you have sidecar files that are used in your command, but are not input files, use the --include option to make those files available to the execution.

You'll receive a tracking ID that you can use to check the status of your execution.

Executiuons are queued while a remote worker is built. Once the worker is created, your execution will begin.

Full execute documentation.

3. Check Job Status

At any point in the process, you can check the status of your execution. You can leave off the <tracking-id> to view the status of the last execution queued.

Full status documentation.

4. Watch the Logs

While the execution is in process, you can use the watch command to view any outputs from the remote ffmpeg process. Once the execution is complete, the full logs will be output.

Full watch documentation.

5. Download the Results

Once the execution has finished successfully, you can use the get command to download the results of the execution. Any files that your ffmpeg command generated will be included in the output, as well as a ffremote-output.txt file that contains all of the stdout & stderr of the execution.

Full get documentation.