OpenResearch
Run parallel research agents with any model
Easily tunnel the Orx dashboard service to a remote SSH host using automatic or manual methods. Learn how to access your Orx dashboard securely from anywhere.
How orx up Starts the Local Dashboard and API in OpenResearchDiscover how orx up starts the local dashboard and API in OpenResearch. Learn about TCP listeners, LLM hosts, and Axum HTTP servers for seamless operation.
How to Install Reusable Agent Skills with `orx`: A Complete GuideLearn how to install reusable agent skills with orx. This guide shows how the orx install-skills command enables agents to discover and invoke the orx command automatically.
How the plan_gate Module Controls Agent Permissions in orxDiscover how the plan_gate module controls agent permissions in orx. Learn about its allow-list policy for read-only operations and user approval for destructive actions in Claude's --permission-mode plan.
Where to Find Agent Harnesses for Different Coding Agents in orxDiscover agent harnesses for Claude Code, OpenCode, Cursor, and Codex within the alphaXiv/OpenResearch repository. Find them in the src/local/harness/ directory.
How orx Handles Python Streaming for CPython Jobs: Real-Time Output Across Backendsorx ensures real-time Python streaming for CPython jobs by setting PYTHONUNBUFFERED and PYTHONIOENCODING across all backends like Modal, Slurm, Kubernetes, and more. Get instant stdout/stderr.
Which Backend Kinds Does orx Support? A Complete Guide to OpenResearch Compute BackendsDiscover the nine backend kinds supported by orx: hf_job, k8s_job, modal_job, slurm_job, ssh_job, ray_job, openresearch_job, local_job, and tinker_job. Explore the complete guide to OpenResearch compute backends.
What Is the BackendDescriptor in orx and How Is It Serialized?Understand the BackendDescriptor in orx, a data structure for backend job metadata. Learn how it serializes to JSON using serde for SQLite integration in this technical guide.
StoredRun, LocalExperiment, and LocalProject Types in orx: A Complete GuideExplore StoredRun LocalExperiment and LocalProject types in orx for efficient local research artifact management. Understand their roles in persistence and organization.
How orx Uses a Lifecycle Lock for Atomic Destructive OperationsDiscover how orx utilizes a file-based lifecycle lock with fd_lock RwLock for exclusive and atomic destructive operations, safeguarding persistent state from concurrent mutations.
ORX Data Directory Resolution Order: How OpenResearch Locates Your DataUnderstand the ORX data directory resolution order. Learn how OpenResearch finds your data by checking ORX_DATA_DIR, XDG_DATA_HOME, and your home directory.
Where Are orx Run Logs Stored? Log File Paths in OpenResearchDiscover where orx run logs are stored in alphaXiv OpenResearch. Find log file paths generated by the log path helper function in src/store.rs.
Have a question about this repo?
These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:
curl -s "https://instagit.com/install.md" 
Maintain an open-source project? Get it listed too →