Install
Runtime Requirements
vidtrace orchestrates local media tools. Install these before running extraction:
ffmpegffprobetesseractwhisper
Run vidtrace doctor after installation. It checks binaries, Tesseract language data, and cached Whisper models.
Homebrew
The Homebrew cask is published from tagged releases:
brew tap abdul-hamid-achik/tap
brew install --cask abdul-hamid-achik/tap/vidtrace
vidtrace version
vidtrace doctorUpgrade to the latest published cask with:
brew update
brew upgrade --cask abdul-hamid-achik/tap/vidtracevidtrace is not signed with an Apple Developer certificate yet. If macOS blocks the first run, clear quarantine on the installed binary:
xattr -dr com.apple.quarantine /opt/homebrew/Caskroom/vidtrace/*/vidtraceInstall common runtime dependencies on macOS:
brew install ffmpeg tesseract
pipx install openai-whisperWhisper downloads its model on first use. vidtrace defaults to the small model.
Linux packages
Tagged releases publish .deb and .rpm packages (amd64 and arm64) as GitHub release assets. Download the one for your distribution and architecture, then install it:
# Debian / Ubuntu
sudo dpkg -i vidtrace_<version>_linux_amd64.deb
# Fedora / RHEL
sudo rpm -i vidtrace_<version>_linux_amd64.rpmThe package installs vidtrace to /usr/bin. It does not pull the media tools as hard dependencies (their package names vary and Whisper is installed via pip), so install them separately and confirm with vidtrace doctor:
# Debian / Ubuntu
sudo apt-get install ffmpeg tesseract-ocr
pipx install openai-whisperA .tar.gz of just the binary is also attached to every release for manual installation.
Source Build
Development tool versions are pinned in .tool-versions.
git clone https://github.com/abdul-hamid-achik/vidtrace.git
cd vidtrace
task build
bin/vidtrace doctorRequired development tools:
- Go
1.26.4 - Task
3.51.1 - golangci-lint
2.12.2 - GoReleaser
2.16.0 - glyphrun
v0.1.0-e224a88-devor newer for E2E specs
Verify
vidtrace version
vidtrace doctor
vidtrace docs agentOCR language data
vidtrace extract defaults to English (--ocr-lang eng). To OCR other languages, install the matching Tesseract language data and pass them with +, for example --ocr-lang eng+spa. Extraction fails fast and names any missing packs before doing work, so install them first:
# macOS (Homebrew bundles many languages with tesseract; tesseract-lang adds the rest)
brew install tesseract-lang
# Debian/Ubuntu (one package per language, e.g. Spanish)
sudo apt-get install tesseract-ocr-spaList what is installed with tesseract --list-langs, or run vidtrace doctor, which reports the available Tesseract languages.