Install

The desktop app is the recommended way to use OpenResearch. It includes the orx CLI that agents use and updates itself.

macOS

Universal app for Apple silicon and Intel. Requires macOS 11 or later.

Windows (beta)

OpenResearch-Setup.exe installs for your user without an admin prompt. OpenResearch needs Git for Windows for bash; the app offers to install a portable copy during onboarding. SmartScreen may warn on first launch.

Linux

Requires glibc 2.35 or later (Ubuntu 22.04, Debian 12, Fedora 36) and fusermount. Keep the AppImage somewhere writable, such as ~/Applications, so it can update itself.

chmod +x OpenResearch-x86_64.AppImage
./OpenResearch-x86_64.AppImage

Without FUSE, run it with --appimage-extract-and-run.

Use orx in your terminal

The app's orx isn't on your terminal's PATH by default.

• macOS app: open Settings > Updates and click Install the orx command. This links it into ~/.local/bin.
• Windows: run the PowerShell installer below.
• Linux app: run only the curl line below.
• macOS or Linux without the app: install the standalone CLI, then run orx up to open the dashboard in your browser at http://127.0.0.1:4791. On managed Macs, device policies may block it because it isn't signed yet; use the app instead.

# macOS / Linux
curl -LsSf https://openresearch.sh/install.sh | sh
orx up

# Windows (PowerShell)
powershell -ExecutionPolicy Bypass -c "irm https://github.com/alphaXiv/OpenResearch/releases/latest/download/openresearch-cli-installer.ps1 | iex"

Sign in

An account is only needed for managed compute. Run orx login, or sign in under Compute > OpenResearch in the app.

Updates and analytics

The app updates itself; use orx update for installer-script installs. Release builds send coarse, opt-out usage analytics that exclude your code, prompts, and file contents. Agents can also file feedback reports, which they're told to strip of sensitive details. Turn both off in Settings or with orx telemetry off.