openresearch-cli
Use the `orx` CLI to run local OpenResearch projects from a terminal — create experiment branches, launch and supervise compute, inspect logs and evidence, and manage the experiment tree. Read this before driving `orx` programmatically.
Install / Use
npx skills add alphaXiv/OpenResearchInstalls into whichever agent you are using.
SKILL.md
Installable skill definition
Quality Score
Category
Education & ResearchSupported Platforms
Tags
Our assessment of openresearch-cli
openresearch-cli scores 77/100 on our quality scale, 383rd of 421 Education & Research skills we index.
Its SKILL.md is 11 KB long, well organised into 13 sections with 2 code examples: a thorough specification that gives an agent plenty to work with.
It has no GitHub stars yet, so there is no community track record; judge it on its content.
Maintenance, license and trust
- The repository was last updated 2 days ago, so openresearch-cli is actively maintained.
- No license is declared. By default that means all rights are reserved: you can read it, but reusing or redistributing it is not clearly permitted. Ask the author before building on it commercially.
- Its trust signals score 80/100, with 2 cautions from licensing, adoption, age or documentation. These come from repository metadata, not a code audit — read the skill file before letting an agent act on it.
Safety scan
No issues foundOur scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful.
AI review by kimi-k2.7-code on 2026-11-16. Automated pattern scan on 2026-11-16. It catches known dangerous patterns, not every risk — read a skill before letting an agent act on it.
openresearch-cli compared with similar skills
All 4 of these similar skills score higher than openresearch-cli; compare them before choosing.
| Skill | Score | Stars | Updated | Format |
|---|---|---|---|---|
| openresearch-cli (this skill)by alphaXiv | 77 | 0 | 2d ago | SKILL.md |
| last30days-skillby mvanhorn | 100 | 68.0k | today | CLAUDE.md |
| x402by browser-use | 100 | 121.0k | 3d ago | SKILL.md |
| algorithmic-artby anthropics | 100 | 177.9k | 55d ago | SKILL.md |
| pptxby anthropics | 100 | 177.9k | 55d ago | SKILL.md |
Frequently asked questions
- How do I install openresearch-cli?
- Run
npx skills add alphaXiv/OpenResearch. The install tabs above show the steps for each supported agent. - Which AI agents does openresearch-cli work with?
- It is written for Universal, as a SKILL.md file. Other agents that read the same format can often use it too.
- Is openresearch-cli safe to use?
- Our scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful. It declares no license and scores 80/100 on trust signals. Skills are instructions an agent will follow, so read the file before installing it and do not approve commands you do not understand.
- Is openresearch-cli still maintained?
- The repository was last updated 2 days ago, so openresearch-cli is actively maintained.
Skill content
View source on GitHubname: openresearch-cli
description: Use the orx CLI to run local OpenResearch projects from a terminal — create experiment branches, launch and supervise compute, inspect logs and evidence, and manage the experiment tree. Read this before driving orx programmatically.
OpenResearch CLI (orx)
orx up owns projects, experiment branches, and execution in a local Git
repository and local database. Use the local session worktree to read, diff,
and edit code (see orx-git).
This overview is deliberately short: it carries the cardinal rules and a command
quick-reference, then points at focused modules for everything else. Load a
module with orx skill <name> (the bundled index is printed at the end of orx skill output).
Cardinal rules — read before doing anything else
These four govern everything below. Breaking any one silently invalidates your
results — they are not style preferences. The orx-experiment-tree module
expands on the why; these are the non-negotiables.
- Never edit a node once a run has answered it. A node freezes the moment
a run establishes its baseline or tests its hypothesis — that includes the
root — and freezing is permanent: a disappointing result is still a result.
Until then it is provisional: seeding it, fixing its deps, and making it
run all happen on its own branch (
orx-experiment-tree). To test a new hypothesis, branch a child and edit the child. - The run command and the environment are a fixed contract — identical on
every node. A child inherits its parent's run command verbatim; leave it
alone. Do not give nodes different start commands, and do not vary
behavior through environment variables or env-prefixed commands
(
LR=3e-4 python …). The only thing that may differ between nodes is the committed code/config on the node's git branch. Set the local project's command once withorx project edit <projectId> --run-command '<cmd>'. - Vary code, not knobs-in-the-command. Encode hyperparameters in the code/config files and branch a child per variant — never sweep them by editing the run command or passing env vars. Every node runs the same command over different code, so their logged result summaries stay comparable.
- Grow the tree downward, not sideways. Fan a little within a round (the
options of one decision), then descend onto that round's winner for the
next round. A root with a long row of direct children and no grandchildren is
the failure mode. See "Shape the tree" in the
orx-experiment-treemodule.
If you're ever tempted to change the command, pass an env var, or pile another node onto the root instead of branching a child, editing its branch, and descending — stop. That's the anti-pattern, not a shortcut.
Setup
orx login # opens a browser, stores a token at ~/.config/openresearch/credentials.json
orx logout # remove the stored token
- The API base URL resolves from
--api-url→OPENRESEARCH_API_URL→ a built-in default. SetOPENRESEARCH_API_URLfor non-local use. - Local project and run commands do not require a token. OpenResearch compute,
instance provisioning, and account settings require
orx login.
Command quick-reference
Project-scoped commands take a project id; experiment-scoped commands take an
experiment id; run-scoped commands take a run id. Don't mix them — get
ids from orx projects, orx project view, and orx runs respectively. Each
group below has a module (orx skill <name>) with the full flags and rules.
Auth
| Command | What it does |
|---|---|
| orx login [--api-url <url>] [--device] | Open a browser, do loopback OAuth, store a token. --device (the default over SSH) prints a link and code to approve on any device. |
| orx logout | Remove the stored token. |
Discover (project- and experiment-scoped)
| Command | What it does |
|---|---|
| orx projects [--json] | List projects in the local orx store. |
| orx orgs [--json] | List organization ids available for OpenResearch compute (login required). |
| orx project view <projectId> | Show a local project's details and experiment tree. Experiment ids come from here. |
| orx runs <projectId> [--experiment <id>] | List runs as a table, newest first. Run ids come from here. |
Run evidence (run-scoped) — module orx-logs
| Command | What it does |
|---|---|
| orx logs <runId> | Show the local log path, size, and short preview; inspect the file for full evidence. |
Create and run experiments (write) — modules orx-create, orx-compute, orx-git
| Command | What it does |
|---|---|
| orx up | Open the local dashboard to import or create a local project. |
| orx project edit <localProjectId> [--name "<n>"] [--run-command "<cmd>"] | Edit a local project's name or fixed run command. |
| orx project share <localProjectId> [--out <file> \| --publish] [--chat <chatId>... \| --no-chats] [--no-logs] [--no-artifacts] | Only when the user asks: save the project's code, experiment tree, finished runs, logs, artifacts and chats as a .orx file to send to a collaborator. --chat narrows it to the named chats. --publish (only when the user asks for a link) uploads it to openresearch.sh and prints a link anyone can open; publishing again updates the same link. |
| orx project unpublish <localProjectId> | Delete the project's published link and its file. |
| orx project import <file.orx \| link> [--path <dir>] | Open a shared .orx file or an openresearch.sh/p/... link as a new local project with its tree, runs and chosen chats. |
| orx create-experiment <localProjectId> --title "<t>" [...] | Add a local experiment node; prints its Git branch. |
| orx compute status / show <backend> / test <backend> | Inspect machine-wide compute configuration and readiness. |
| orx compute configure <backend> --help / default set <backend> / connect <backend> | Configure compute or authenticate; load orx-compute. |
| orx compute instructions show --json | Read the machine-wide custom recipe and its revision before configuring or launching. |
| orx compute [--gpu <id>] [--count <n>] [--provider <name>] / orx compute --cpu | List the GPU/CPU compute catalog. |
| orx instance create <orgId> (--gpu <id> … \| --cpu <flavor> …) | Spin up a standalone instance in an org; see orx-instances. |
| orx exp status/run/cancel/wait/wake <localExpId> | Inspect, run, cancel, wait on, or register a wake-up for a local experiment node. |
| orx exp move/archive/unarchive/delete <localExpId> | Re-parent, hide, restore, or permanently delete experiment nodes; see orx-experiment-tree. |
| orx exp desc <expId> [--set "<text>" \| --stdin] | Read or overwrite the experiment's description. |
To read or edit a node's code—including diffing what a run changed—use plain
Git in the local session worktree. See the orx-git module.
Literature & papers — alphaXiv / OpenAlex / bioRxiv / PubMed (no login required) — module orx-lit-review
Use before any web search for academic/research queries (paper, author, blog, model release).
| Command | What it does |
|---|---|
| orx discover keyword "<query>" | Call the alphaXiv full-text retrieval primitive with match snippets. |
| orx discover embedding "<query>" | Call the alphaXiv semantic retrieval primitive. The main agent ranks candidates and decides focused follow-ups; see orx-lit-review. |
| orx discover openalex "<query>" | Search the cross-disciplinary OpenAlex scholarly graph. |
| orx discover biorxiv "<query>" | Search bioRxiv preprints through OpenAlex's bioRxiv index. |
| orx discover pubmed "<query>" | Search PubMed biomedical literature through NCBI E-utilities. |
| orx paper <id\|url> [--source <source>] [--full] | Fetch a paper: alphaXiv report with automatic full-text fallback (--full forces raw text), or OpenAlex/bioRxiv/PubMed metadata+abstract. Source auto-detected from the id. |
Skills & templates — module orx-customize
| Command | What it does |
|---|---|
| orx skills add <path> | Save a reusable skill from a SKILL.md file or skill ZIP across projects. |
| orx templates add <path> | Save a reusable LaTeX template from a .tex file or template ZIP across projects. |
Meta
| Command | What it does |
|---|---|
| orx skill [name[/resource]] | Print this overview, one bundled module, or a lazily loaded module resource such as compute/hf. |
| orx feedback --kind <bug\|feature_request\|frustration> --summary <summary> --details <details> | Report a meaningful OpenResearch bug, feature request, or user frustration to its maintainers. See the orx-feedback module. |
Modules
The detail lives in focused modules — load one with orx skill <name> (the bundled
list, with one-line descriptions, is printed at the end of orx skill output):
- orx-experiment-tree — the experiment-tree model, the auto-research loop, and
orx exp desc. - orx-create — initialize a local project and add local experiment nodes.
- orx-compute — launch and monitor runs; after resolving the backend, read its bundled reference.
- orx-instances — create persistent standalone machines for manual work.
- orx-git — read, edit, and diff a node's code with plain git.
- orx-agent-delegation — delegate to other models and chats with orx's MCP tools.
- orx-logs — retrieve persisted run output for progress, debugging, or measurements.
- orx-results — interpret, compare, and summarize measured experiment outcomes.
- orx-reports — write durable research outputs into the project's artifacts directory.
- orx-figures — publication-quality figures in matplotlib or TikZ. Load it before writing any plotting code, then read the one reference for that figure type.
- orx-customize — add reusable skills and LaTeX templates across projects.
- orx-paper — draft a paper or preprint as LaTeX that renders and compiles to PDF.
- orx-feedback — report meaningful OpenResearch bugs, feature requests, and user frustration without leaking research details.
- orx-lit-review — main-agent cross-corpus retrieval, source-selective follow-up policy, and paper content; the preferred starting point for academic/research queries.
Typical workflow
Orienting in a project (read-only discovery):
orx projects # find the project id
orx project view <projectId> # see the tree, pick an experiment id
orx skill experiment-tree # the model + the auto-research loop
orx runs <projectId> # find a run id
orx logs <runId> # locate its log, then inspect the file
To actually drive a project toward a goal — edit each node's code on its Git
branch and keep the round moving — follow the auto-research loop in
the orx-experiment-tree module. Every completed run is a decision point with
four moves: repair the same node when a run answered nothing, refill
the round with another sibling, promote the winner and descend, or stop.
Related Skills
last30days-skill
68.0kAI agent skill that researches any topic across Reddit, X, YouTube, HN, Polymarket, and the web - then synthesizes a grounded summary
x402
121.0kSet up Browser Use Cloud payments with x402 — pay per request from a crypto wallet (USDC on Base mainnet), no signup or API key.
algorithmic-art
177.9kCreating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users request creating art using code, generative art, algorithmic art, flow fields, or particle systems.
pptx
177.9kUse this skill any time a .pptx or .potx file is involved in any way — as input, output, or both. This includes: creating slide decks, pitch decks, or presentations; reading, parsing, or extracting text from any .pptx or .potx file (even if the extracted content will be used elsewhere, like in an em…
Trust signals
From repository metadata: license, adoption, age and documentation. Not a code audit — see the Safety scan above for what the skill file itself contains.
