OpenLoreDocumentationGitHub ↗
InstallationOpenLore / Guides

Install OpenLore

On this page

Release binaries include the dashboard. Choose the installation method that fits your environment.

Mac and Linux

The installer detects Intel/x86-64 or ARM64, downloads the latest release, verifies its SHA-256 checksum, and installs openlore into ~/.local/bin. It does not use sudo, start services, or edit your shell configuration.

The homepage’s curl -fsSL https://openlore.sh/install.sh | sh command is a shortcut for interactive setup. A pipeline can start executing before the download finishes and can report success when the download fails. For automation or inspection before execution, use the download-first method:

curl -fsSL https://openlore.sh/install.sh -o install.sh &&
sh install.sh

This downloads install.sh into your current folder and runs it only if the download succeeds. Installation failures return an error too. The downloaded script stays available for inspection; remove it when you no longer need it.

View the installer before running it. To inspect a local copy first:

curl -fsSL https://openlore.sh/install.sh -o install-openlore.sh &&
less install-openlore.sh &&
sh install-openlore.sh

Checksums detect a corrupt or mismatched download. They are published alongside the binaries on GitHub; they are not an independent publisher signature.

Choose a version or install directory

Use a release tag from GitHub Releases to pin a version:

curl -fsSL https://openlore.sh/install.sh -o install.sh &&
sh install.sh --version v0.7.5

Choose an absolute installation directory you can write to:

curl -fsSL https://openlore.sh/install.sh -o install.sh &&
sh install.sh --install-dir "$HOME/bin"

You can combine both options. Re-run the installer to upgrade, or use --version to replace the binary with a specific release. If the directory is not on your PATH, the installer prints the line to add yourself. To uninstall, remove the installed openlore binary; this does not remove workspace files.

Homebrew

Available on macOS and Linux, for Intel/x86-64 and ARM64:

brew install --cask aakarim/tap/lore

For upgrades, use brew upgrade --cask aakarim/tap/lore. To pin a particular release, use the script above instead.

Windows

Download and extract the latest Windows x64 release in PowerShell:

$url = 'https://github.com/aakarim/OpenLore/releases/latest/download/openlore_windows_amd64.zip'
Invoke-WebRequest -Uri $url -OutFile openlore.zip
Expand-Archive openlore.zip -DestinationPath .\openlore -Force
.\openlore\openlore.exe version

To choose a version, replace latest/download in the URL with download/v0.7.5 (or another published tag). Windows ARM64 binaries are not currently published. You can compare Get-FileHash openlore.zip -Algorithm SHA256 with the matching release’s checksums.txt before extracting.

Install with AI

Choose your installed, signed-in agent CLI. Run the matching command in a POSIX shell to fetch the onboarding instructions and open an interactive setup conversation.

Claude Code

claude "$(ssh openlore.sh teach)"

Codex

codex "$(ssh openlore.sh teach)"

Gemini CLI

gemini -i "$(ssh openlore.sh teach)"

OpenCode

opencode --prompt "$(ssh openlore.sh teach)"

These commands pass the instructions as an initial prompt while keeping terminal input available for your answers. They do not enable automatic permission approval or install the agent CLI itself. This is not a separate binary distribution.

Start your workspace

If you used the script and ~/.local/bin is not on PATH, make it available in this terminal first:

export PATH="$HOME/.local/bin:$PATH"
openlore version
openlore ./docs

On Windows, use the path to openlore.exe unless you have added its folder to PATH. Continue with the Quickstart to connect your agents, or build from source if you need a custom build.

← All guidesExplore the full documentation →Back to top ↑