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
这是什么？OpenResearch 是一个本地优先的工作区，能把 Claude Code、Codex、OpenCode、Cursor 或 Google Antigravity 等编码代理变成研究代理，让它们可以查阅文献、提出假设、运行实验并产出研究成果。
这是命令行工具，还是有图形界面？两者都是：orx CLI 会在你的浏览器中启动一个本地仪表盘，其背后是 git 原生的实验树和本地 SQLite 存储。
怎么把它跑起来？在 macOS 或 Linux 上安装 CLI 并运行「orx up」打开本地仪表盘；Windows 上有一个 beta 版下载，需要先安装 Git for Windows。
可以接入哪些编码代理？支持 Claude Code、Codex、OpenCode、Cursor 和 Google Antigravity，你还可以通过 LM Studio、oMLX、Ollama 接入本地模型，或通过 OpenCode 使用自定义端点。
在共享的远程机器上运行安全吗？不完全安全——当你通过 SSH 或在远程 GPU 附近运行工作区时，服务虽然只绑定到环回地址，但没有应用层的身份验证，同一主机上的其他用户仍可能访问到它。
它在 Windows 上能用吗，还是只有 Mac 和 Linux？可以，但 Windows 支持仍处于 beta 阶段，需要先安装 Git for Windows；macOS 要求 11 及以上版本，Linux/macOS 则提供完整的经过签名的 CLI 安装。
我的研究代码和数据会被送到哪里？默认情况下没有任何东西离开你的电脑：OpenResearch 运行在 127.0.0.1 上并使用本地 SQLite 存储，创建项目或启动运行都不会发布你的代码；openresearch.sh 账号仅用于组织场景和托管算力。
autoresearch 是什么？Autoresearch 是 OpenResearch 的自主循环：代理提出想法、修改代码、启动实验、检视证据并决定接下来尝试什么；多个代理可以并行探索不同方向，同时由实验树保留各自的来龙去脉。
除了我的笔记本电脑，实验还能在哪里实际运行？同一份提交的源代码快照可以在本地、通过 SSH，或在 Slurm、Kubernetes、Ray、Hugging Face Jobs、Modal、Tinker 或 OpenResearch 托管算力等远程基础设施上运行。
它是如何保证实验可复现的？它在 git 原生的实验树中追踪各个变体，每次运行都会获得与其记录提交对应的不可变存档，因此日志、diff、文件和结果始终与产生它们的工作绑定在一起。
OpenResearch 会发送遥测数据吗？官方发布版本会发送可选择性退出的粗粒度使用事件，并与随机的安装 ID 关联，不包含代码、提示词、文件内容、路径、仓库名、token 或电子邮箱；可以用「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
172.9 MB
Stars
7.3K
Updated
CommitOct 16Releasev0.2.19Oct 15
Age
4mo
Commits · 90 Days