Install
Choose a desktop installer or complete command-line runtime for your platform.
Choose a package
Open the download page or GitHub Releases. Choose an asset for your operating system and architecture from the same release. OpenCorvus is actively developed; read that release’s notes before installing or updating.
- Desktop: use the Windows installer, macOS disk image, or Linux package listed for your platform.
- Command-line use: extract the complete
opencorvus-<platform>.tar.gzruntime bundle. Keep its executable and supporting files together. Add its executable directory to your command search path.
Compare the downloaded file against that release’s SHA256SUMS. A desktop installer
and a command-line runtime archive are different packages; choose the one you intend to use.
The download page and release notes are the authority for currently available formats.
Verify the local runtime
For command-line use, run:
opencorvus --versionopencorvus doctordoctor checks local platform capabilities such as native modules and the shell.
It does not send a model request or validate provider credentials. Review warnings
before attempting a task that depends on the affected capability.
Git is needed for repository and worktree operations. Some skills also require Python. Follow the dependency guidance for the capability you intend to use.
Build from source
Source builds require Bun 1.3.14 or newer and Node.js 22 or newer. On Windows, prepare Rust/Cargo and the Visual Studio C++ build tools before building; follow the repository’s Windows toolchain setup.
git clone https://github.com/yangheng95/opencorvus.gitcd opencorvusbun installbun run package:native-binarybun packages/opencorvus/src/index.ts doctorThe bundle and archive are written under packages/opencorvus/dist/.
Native packaging has platform-specific prerequisites; see the repository’s
packaging guide.
Configure a model and start
Continue to Quickstart to configure an exact model, start the runtime and inspect a first result. The model and credential must belong to the same provider; see providers for supported configuration methods.