Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/damianiglesias/omniform/llms.txt

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

This page walks you through everything from a fresh Omniform checkout to a completed download with a converted file sitting in your output folder. It assumes you have Node.js 18+ and Rust already installed on your machine. If you haven’t set those up yet, start with the installation guide first.
Need to install Node.js, Rust, or the Tauri system prerequisites first? See the Installation page for full setup instructions.

​
Your first download

1

Clone and install

Clone the repository and install all npm dependencies in one go:
git clone https://github.com/damianiglesias/omniform.git && cd omniform && npm install
This clones the repo, moves into it, and installs the React frontend dependencies along with the Tauri CLI.
2

Start the app

Launch Omniform in development mode:
npm run tauri dev
Tauri compiles the Rust backend, starts the Vite dev server, and opens the app window. On this first run, Omniform will detect that yt-dlp and ffmpeg are not yet present and automatically download them. A dependency banner appears at the top of the window showing the current download status (e.g. “Downloading yt-dlp…” followed by “Downloading ffmpeg…”). Wait for the banner to disappear — once it does, both tools are ready and the download queue is active.
3

Set your output folder

Click the output folder button in the interface and choose a directory where downloaded and converted files will be saved. If you skip this step, Omniform uses your system’s default Downloads folder automatically (resolved via dirs::download_dir()).
4

Paste a URL and pick your settings

Copy a URL from YouTube, TikTok, Instagram, or any other yt-dlp-supported site. When you focus the Omniform window, it reads your clipboard and pre-fills the URL field automatically — no manual pasting required.Next, choose your output settings:
  • Format — select a video format (MP4, WebM) or an audio format (MP3, WAV, FLAC, M4A, OGG).
  • Quality — for video, choose from Best, 1080p, 720p, or 480p. For audio, choose from High (320 kbps), Medium (160 kbps), or Low (96 kbps).
When you’re ready, click Add to queue.
5

Watch the queue

The download queue shows each active job with:
  • Real-time progress — a progress bar showing how much of the file has been downloaded
  • Speed — the current download speed
  • ETA — the estimated time until the download completes
When the job finishes, the converted file is written to your chosen output folder. If you need to stop a download early, use the cancel button on the queue item — it stops only that job without affecting any other active downloads.
Omniform checks your clipboard every time the app window receives focus. If you copy a YouTube or TikTok URL before you open or switch to the app, the URL will already be in the input field when you get there — no need to paste it manually.

​
What’s next

Formats & Quality

Learn every format option and when to use each one.

Download Queue

Understand queue behavior, cancellation, and error handling.

Build docs developers (and LLMs) love

Get started for freeTalk to us