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…

Что это?OpenResearch — рабочее пространство с принципом local-first, превращающее кодинг-агентов вроде Claude Code, Codex, OpenCode, Cursor или Google Antigravity в исследовательских агентов, которые умеют изучать литературу, развивать гипотезы, проводить эксперименты и создавать исследовательские артефакты.
Это CLI-инструмент или у него есть GUI?И то, и другое: CLI «orx» запускает локальный дашборд в браузере, опираясь на git-нативное дерево экспериментов и локальное хранилище SQLite.
Как его запустить?Установите CLI на macOS или Linux и выполните 'orx up', чтобы открыть локальный дашборд; на Windows есть бета-загрузка, требующая предварительной установки Git for Windows.
Каких кодинг-агентов можно подключить?Поддерживаются Claude Code, Codex, OpenCode, Cursor и Google Antigravity, а локальную модель можно подключить через LM Studio, oMLX, Ollama или собственный эндпоинт через OpenCode.
Безопасно ли запускать на общем удалённом компьютере?Не совсем — когда пространство запускается по SSH или рядом с удалёнными GPU, сервис слушает только loopback, но не имеет аутентификации на уровне приложения, так что другие пользователи этого хоста всё же могут до него добраться.
Работает на Windows, а также на Mac и Linux?Да, но поддержка Windows пока в бете и требует предварительной установки 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-нативном дереве экспериментов, и каждый прогон получает неизменяемый архив своего зафиксированного коммита, так что логи, диффы, файлы и результаты остаются привязанными к работе, которая их породила.
Отправляет ли OpenResearch телеметрию?Официальные релизные сборки отправляют отключаемые грубые события использования, привязанные к случайному ID установки, — без кода, промптов, содержимого файлов, путей, имён репозиториев, токенов или почты; полностью отключается командой 'orx telemetry off'.
Creator
alphaXiv
Size
173.7 MB
Stars
7.3K
Age
4mo
Commits · 90 Days