Skip to main content
Contributing & community
Test local CLI changes
Run an unreleased HyperFrames CLI build against a real project outside the monorepo.
Package tests do not prove that the CLI behaves correctly in an ordinary video project. After the focused tests pass, run the changed command against a project outside the HyperFrames repository.
Rebuild after changing CLI code or a package bundled by the CLI.
The resolved binary should point into the local HyperFrames checkout. Run it from a separate project:
Remove the link when finished.
Run the archive against an isolated project as well as the command you changed.
Build the workspace
From the repository root:Run the local build
Choose one method.Link the CLI
Use this when you will test several commands or projects:bun unlink takes no package name — it
unregisters whichever directory you run it from, so go back to the CLI package in
your HyperFrames checkout first (an absolute path, since you are now inside the
video project):
Call the built entry directly
Use this when you do not want to change yourPATH:
Test the package archive
Use this before a release to check the files that would actually be published:What to verify
Test the user-visible outcome, not only the exit code:- the command accepts the documented arguments;
- errors explain how to recover;
--jsonremains machine-readable when the command supports it;- Preview opens the correct project and reflects file changes;
- a render produces a playable file with the expected duration and media;
- temporary files and background processes are cleaned up after success and failure.
ffprobe or the repository’s existing fixture tests rather than relying on visual playback alone.
Common problems
If a globally installed CLI shadows the link, inspectwhich hyperframes, remove the global package, and link again. Preview starts at port 3002 and automatically tries a free port; pass --port only when a fixed port is required.