Release installs first
macOS casks and Linux release artifacts are the main path for trying OpenClue today.
Install OpenClue
Choose a platform path, then bootstrap one root.
OpenClue supports macOS and Linux today. After installing the binary, run
oclue config init or oclue --repo-config config init to set up
the deterministic baseline for your chosen root mode. Public install guidance here stays focused on
the release paths that exist today.
Current status
Keep the first install path simple
OpenClue is still experimental. For now, this page stays intentionally narrow: use the public binary releases and keep the install story aligned with what is actually available.
Source remains private
Public install guidance does not depend on direct source access. Start from the shipped binaries instead.
Platform support
Supported targets today
The current release flow produces a macOS app bundle plus CLI binaries, and Linux packages
or tarballs for direct installation. Sandbox enforcement depends on the matching host backend:
sandbox-exec on macOS and bwrap/bubblewrap on Linux.
| Requirement | macOS | Linux |
|---|---|---|
| OpenClue binary | Required | Required |
| Sandbox backend for enforce mode | sandbox-exec |
bwrap / bubblewrap |
| Extra system tools | Depends on active skills | Depends on active skills |
macOS
Install with Homebrew Cask
This is the cleanest path for regular macOS use. It installs the Finder-visible
OpenClue.app bundle as well as both CLI entrypoints in your PATH.
brew tap juangamnik/openclue
brew install --cask openclueWhat the cask installs
OpenClue.appfor Finder-visible distribution on macOSocluein PATH as the primary commandopencluein PATH as a compatible aliasLICENSEandRISK_NOTICE.txtinside the app bundle
Public distribution repo: github.com/juangamnik/homebrew-openclue
Linux
Download release artifacts directly
Linux releases are published in the public distribution repository. Depending on your environment, use the package format your system already expects or the tarball if you want a minimal manual setup.
Published formats
.debfor Debian or Ubuntu style systems.rpmfor Fedora, RHEL, or compatible systems.tar.gznamed likeopenclue_<version>_linux_<arch>.tar.gz
Public distribution repo: github.com/juangamnik/homebrew-openclue
Release downloads: github.com/juangamnik/homebrew-openclue/releases
Typical package install commands
sudo dpkg -i ./<downloaded-file>.deb
sudo rpm -i ./<downloaded-file>.rpmTarball path
tar -xzf openclue_<version>_linux_<arch>.tar.gz
./oclue version
The tarball is a flat archive. After extraction, place oclue and
openclue somewhere in your PATH if you want them globally available.
After installation
Bootstrap one active root and run your first command
OpenClue uses explicit root modes. Initialize the global root when you want one personal setup, or initialize a repo root when configuration should stay project-bound.
1. Initialize the root
oclue config init
oclue --repo-config config init
oclue --repo-config --bootstrap-profile custom --provider ollama config init
The default verified-defaults profile installs baseline packages and
uses provider openai with model gpt-5-mini.
2. Configure auth and try explain mode
oclue config auth set openai --session --api-key ...
oclue --provider openai --model gpt-5-mini --explain "Summarize this repository"Session-scoped auth is a safe default for testing. You can also persist provider auth under the active root or use environment variables directly.
3. Check host prerequisites
oclue status system check
oclue status system check --jsonThis verifies sandbox backend availability and any extra tool requirements declared by active skills.
4. Run the first real task
oclue "Review the last 200 lines of build.log and propose the next fix"
If no active root is ready yet, oclue and oclue --help surface the guided first-run screen instead of a raw failure.
Continue
Once it is installed, the next question is how you want to run it.
See explain mode, background runs, sessions, permissions, and package-managed capabilities on the usage page.