Practical overview
When it fits
Use the OFX plugin for interactive keying in a supported host, the CLI for local processing or automation, and the GUI when a graphical workflow is preferable.
Who it is for
- Video editors working in DaVinci Resolve or Foundry Nuke who want an OFX keying workflow.
- Users who need local CLI processing, diagnostics, or automation.
- Operators who prefer a desktop graphical interface to command-line use.
Documented uses
- Apply AI-assisted keying to video from within a supported OFX host.
- Process a video locally through the CLI, including with a named preset or external Alpha Hint.
- Check hardware capability and emit machine-readable NDJSON events for integration workflows.
- Use a desktop GUI to work with the runtime without installing the OFX bundle.
Requirements & limits
Pre-packaged releases are listed on the project’s GitHub Releases page. The README identifies public builds for Windows with NVIDIA RTX and macOS on Apple Silicon.
- The project offers distinct plugin, CLI, and GUI surfaces; the GUI does not require the OFX bundle.
- Windows RTX public installer guidance specifies NVIDIA RTX 30 series and newer. The separate DirectML track is experimental and not broadly validated across AMD, Intel, or RTX 20 series.
- macOS installation instructions specify Apple Silicon and DaVinci Resolve 20; the plugin is described as using MLX automatically on M-series chips.
- Source builds require a C++20 compiler, CMake 3.28+, Ninja, and vcpkg with
VCPKG_ROOTset. - Adobe After Effects and Premiere plugins are not supported public surfaces until host validation passes.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Process a video with the CLI
Run the documented local video-processing command using the hardware-aware default preset.
Before you start
- A portable runtime release for the platform; the README gives
corridorkeyfor macOS bundles and source builds, andck-engine.exefor the Windows portable runtime bundle. - An input video and a destination path.
Steps
Download the portable runtime release for the platform.
Run
corridorkey process input.mp4 output.mp4on macOS or a source build; useck-engine.exeas the command name in the Windows portable runtime bundle.
Expected outcome
The CLI is instructed to process the input video to the specified output using hardware-aware defaults.
Guide limitations
- The README does not specify input-format compatibility or processing results.
- Command names differ by bundle and platform; check the release package and support matrix for platform and hardware details.
Install the macOS OFX plugin in DaVinci Resolve
Install the documented Apple Silicon plugin package and add CorridorKey to a clip in Resolve.
Before you start
- An Apple Silicon Mac and the
.pkgApple Silicon installer. - DaVinci Resolve 20.
Steps
Download the Apple Silicon
.pkginstaller.Close DaVinci Resolve and run the installer.
Open Resolve 20, go to the Color or Fusion page, and find CorridorKey in the OpenFX Library.
Drag the node onto the clip.
Expected outcome
The CorridorKey OFX node is placed on a clip; the README says it uses the MLX-accelerated path automatically on M-series chips.
Guide limitations
- This procedure is specifically for macOS on Apple Silicon and DaVinci Resolve 20.
- Check the support matrix for explicit hardware and platform support details.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 17 October 2026
- Original website title
- alexandremendoncaalvaro/CorridorKey-Runtime · Official homepage title · retained in its source language

