OpenResearch README

The project's README from github.com/alphaXiv/OpenResearch. As one markdown file: README.md.

OpenResearch

The local-first workspace for research agents and autoresearch.

Turn Claude Code, Codex, OpenCode, Cursor, or Google Antigravity into research agents that can review literature, develop hypotheses, run experiments, and produce research artifacts.

Download OpenResearch for macOS Download OpenResearch for Windows (Beta) Install OpenResearch for Linux

Documentation · Releases

macOS 11+ · Windows beta requires Git for Windows

GitHub Trending: #1 Repository of the Day alphaXiv/OpenResearch | Trendshift

Get started

Install the CLI on macOS or Linux, then launch OpenResearch:

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

orx up opens the local dashboard at http://127.0.0.1:4791.

On a managed Mac (for example, a work computer), use the macOS download above instead. Device-management policies may block the CLI that install.sh installs because it is not yet signed. The app is signed with a Developer ID and notarized by Apple. To use orx in your terminal, click Install under Install the orx command in the app's Settings → Updates, or run (adjusting the path if the app is not in /Applications):

/Applications/OpenResearch.app/Contents/MacOS/orx install-cli

Either way, orx is linked into ~/.local/bin, with a hint to add it to your PATH if needed. If you already ran install.sh, remove ~/.cargo/bin/orx first and open a new terminal.

On Windows, use the beta download above after installing Git for Windows.

Connect a local model to use LM Studio, oMLX, Ollama, or a custom endpoint with OpenCode.

Create an account at openresearch.sh to receive email updates and use managed OpenResearch compute.

Built for research agents

OpenResearch gives you
Parallel exploration Give each research direction an independent agent session and isolated git worktree.
Reproducible experiments Track variants in a git-native experiment tree; every run receives an immutable archive of its recorded commit.
Evidence in context Keep logs, diffs, files, results, and artifacts tied to the work that produced them.
Your choice of agent Use Claude Code, Codex, OpenCode, Cursor, or Google Antigravity, with the harness and model selected per session.
Your choice of compute Run locally, on your own infrastructure, or with managed OpenResearch compute.
Local ownership Keep projects, conversations, experiments, runs, logs, code, and artifacts on your machine.

Autoresearch

OpenResearch can run the full loop autonomously: propose an idea, change the code, launch an experiment, inspect the evidence, and decide what to try next. Multiple agents can explore different directions in parallel while the experiment tree preserves their lineage.

Run anywhere

The same committed source snapshot can run locally, over SSH, or on Slurm, Kubernetes, Ray, Hugging Face Jobs, Modal, Tinker, and managed OpenResearch compute. Publishing the repository is not required.

Run the workspace next to remote GPUs while using the browser on your laptop:

orx up --remote user@host

SSH config aliases and custom ports are supported. The remote service binds to loopback and has no application-level authentication, so other users on that host can reach it.

CLI and agent integration

Install the OpenResearch skill into supported coding agents:

orx install-skills

Common commands:

orx projects
orx project view <project-id>
orx runs <project-id>
orx logs <run-id>
orx exp run <experiment-id>
orx discover keyword <query>
orx paper <arxiv-id-or-doi>

Run orx --help or orx <command> --help for the complete interface.

Local by default

OpenResearch runs on 127.0.0.1 with a local SQLite store. Creating a project or launching a run does not publish your code. An openresearch.sh account is only used for service-owned capabilities such as organizations and managed compute.

Usage analytics

Official release builds send opt-out, coarse usage events tied to a random installation ID. They do not include code, prompts, file contents or paths, repository names, tokens, emails, or project and experiment identifiers.

orx telemetry off
orx telemetry status
orx <command> --no-telemetry

Source and development builds do not send analytics.

Coding agents may also file product feedback with orx feedback when you hit a bug, wish for a feature, or get frustrated with OpenResearch. Each report is a short description of the workflow problem, written to omit your research details. Like analytics, reports are sent only from official release builds. They are linked to your account when you are logged in and turned off by orx telemetry off. The --no-telemetry flag covers only the command it is passed to.

OpenResearch (alphaXiv/OpenResearch)

Searching Database…

7.3K ·GitHub
OpenResearch
What is this?OpenResearch is a local-first workspace that turns coding agents like Claude Code, Codex, OpenCode, Cursor, or Google Antigravity into research agents that can review literature, develop hypotheses, run experiments, and produce research artifacts.
Is this a CLI tool or does it have a GUI?It is both: the 'orx' CLI launches a local dashboard in your browser, backed by a git-native experiment tree and a local SQLite store.
How do I get it running?Install the CLI on macOS or Linux and run 'orx up' to open the local dashboard; on Windows there's a beta download that requires Git for Windows installed first.
Which coding agents can I plug in?Claude Code, Codex, OpenCode, Cursor, and Google Antigravity are supported, and you can connect a local model via LM Studio, oMLX, Ollama, or a custom endpoint through OpenCode.
Is it safe to run on a shared remote machine?Not entirely - when you run the workspace over SSH or near remote GPUs, the service binds to loopback but has no application-level authentication, so other users on that host could still reach it.
Does it work on Windows as well as Mac and Linux?Yes, but Windows support is still beta and needs Git for Windows installed first; macOS requires 11+, and Linux/macOS get the full signed CLI install.
Where does my research code and data go?Nothing leaves your machine by default: OpenResearch runs on 127.0.0.1 with a local SQLite store, and creating a project or launching a run does not publish your code; an openresearch.sh account is only used for organizations and managed compute.
What is autoresearch?Autoresearch is OpenResearch's autonomous loop where an agent proposes an idea, changes the code, launches an experiment, inspects the evidence, and decides what to try next, with multiple agents able to explore different directions in parallel while an experiment tree preserves their lineage.
Where can experiments actually run besides my laptop?The same committed source snapshot can run locally, over SSH, or on remote infrastructure like Slurm, Kubernetes, Ray, Hugging Face Jobs, Modal, Tinker, or managed OpenResearch compute.
How does it keep experiments reproducible?It tracks variants in a git-native experiment tree, and every run receives an immutable archive of its recorded commit, so logs, diffs, files, and results stay tied to the work that produced them.
Does OpenResearch send any telemetry?Official release builds send opt-out, coarse usage events tied to a random installation ID, excluding code, prompts, file contents, paths, repo names, tokens, or emails; it can be disabled entirely with 'orx telemetry off'.
What are similar projects?emdash, codify, gastown, lean-ctx, shipyard, foremerge, wicked-studio, fractal
Which topics is it in?academic-research, agent-orchestration, git, cursor, kubernetes, sqlite, multi-agent, dashboard, local-first, coding-agent, rust, codex
Creator
alphaXiv
Size
191.7 MB
Stars
7.3K
Updated
CommitOct 16Releasev0.2.19Oct 15
Age
4mo
Commits · 90 Days