Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ffhub.io/llms.txt

Use this file to discover all available pages before exploring further.

Overview

ffhub is a command-line tool that lets you run FFmpeg commands in the cloud, just like running them locally. Local files are automatically uploaded before processing.

Installation

npm install -g ffhub

Setup

Get your API key from ffhub.io and configure:
ffhub config YOUR_API_KEY
Or set via environment variable:
export FFHUB_API_KEY=YOUR_API_KEY

Usage

Use it just like FFmpeg — prefix your command with ffhub:
ffhub -i https://example.com/video.mp4 -c:v libx264 output.mp4
Local files after -i are automatically detected and uploaded to cloud storage before processing.

Commands

CommandDescription
ffhub [ffmpeg args]Run an FFmpeg command in the cloud
ffhub whoamiShow current user and credits
ffhub listList recent tasks
ffhub status <task_id>Check task status
ffhub config <api_key>Save API key
ffhub helpShow help

List tasks

ffhub list                  # Show recent 10 tasks
ffhub list --limit=20       # Show recent 20 tasks
ffhub list --status=failed  # Filter by status

Check account

ffhub whoami
  Email:    you@example.com
  User ID:  b4e6a3c3-...
  Credits:  15000

How it works

  1. You run ffhub -i local.mp4 -c:v libx264 output.mp4
  2. CLI detects local.mp4 is a local file and uploads it
  3. The FFmpeg command is sent to FFHub cloud for processing
  4. CLI polls for progress and shows real-time status
  5. When done, output file URLs are displayed

Next Steps

FFmpeg API Reference

Use the REST API directly for programmatic access

Get API Key

Sign up and get your API key