Skip to content

docs(cli): explain FFmpeg setup without a package manager - #5237

Merged
jrusso1020 merged 1 commit into
heygen-com:mainfrom
user-github-me:docs/ffmpeg-binary-setup
Oct 8, 2026
Merged

jrusso1020 merged 1 commit into
heygen-com:mainfrom
user-github-me:docs/ffmpeg-binary-setup

Conversation

@user-github-me

Copy link
Copy Markdown
Contributor

When FFmpeg is missing on a Mac without Homebrew, the CLI skill's troubleshooting reference offers no usable setup path even though HyperFrames already supports configured binaries. Document both HYPERFRAMES_FFMPEG_PATH / HYPERFRAMES_FFPROBE_PATH and project-local .hyperframes/bin, including their discovery precedence and Windows filenames.

Add a copyable doctor --json check for the two encoding dependencies. The report also includes optional tools, so checking only its overall ok can reject a working local encoding setup.

Refs #5232. This covers the existing-binary setup documentation; the issue's early workflow preflight and CLI hint proposals remain follow-up work.

Validation: built CLI exercised in seven cases (explicit paths, project-local binaries, both precedence controls, and each/both missing overrides), plus two incomplete-report controls. The documented jq check accepted all four working setups and rejected all missing setups. Root lint, skill cross-references, formatting, comment checks, and commit hooks passed. Confirmed the official FFmpeg download page provides macOS builds. No product behavior or dependencies change.

@jrusso1020 jrusso1020 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this fills a real gap for machines without Homebrew. I checked the documented behavior against the binary resolver and doctor:

  • the env overrides take precedence;
  • PATH is checked before .hyperframes/bin;
  • a configured path that doesn't exist is reported as missing;
  • the FFmpeg and FFprobe entries carry the resolved path.

The jq gate is a sensible way to avoid failing on optional tools.

— Rames

@jrusso1020
jrusso1020 added this pull request to the merge queue Oct 8, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Oct 8, 2026
@jrusso1020
jrusso1020 added this pull request to the merge queue Oct 8, 2026
Merged via the queue into heygen-com:main with commit fe38e8f Oct 8, 2026
55 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants