Skip to content

Quick Start

What You Install

This product is split across two repos:

  • Product runtime: ~/Claude/Harness/omr
  • Public docs site: ~/Claude/arch-site

Only the product runtime is required to run research automation.

New Machine Setup

Prerequisites:

  • Claude Code
  • Node.js 20+
  • Git
  • tmux
  • Optional: codex and gemini CLIs for external workers

Recommended workspace layout:

text
~/Claude/Harness/
  omr/        # product repo
  shared/     # private infra/config
  <projects>/ # research project directories

Install:

bash
mkdir -p ~/Claude/Harness
cd ~/Claude/Harness
git clone git@github.com:JingxuanKang/ohmyresearch.git omr
cd ~/Claude/Harness/omr
./install.sh

After install:

  1. Restart Claude Code.
  2. Open Claude Code in ~/Claude/Harness.
  3. Run omr setup once if you want to refresh hooks, agents, and skills explicitly.

Verification:

bash
which omr
omr --help
cd ~ && omr --help   # should fail outside Harness

Core Commands

Inside Claude Code, the research product revolves around these commands:

CommandPurpose
/research init &lt;name&gt; &lt;description&gt;Create a research project in the current directory
/research statusShow current stage and gate configuration
``/research gate <stage> <humanauto
autopilotAdvance between research stages automatically
ralphLoop inside the current stage until completion criteria are met
ultraworkRun independent research tasks in parallel
/handoffWrite a resumable handoff file for the next session

Gate Types

The runtime gate model is now:

GateMeaning
humanPause for explicit user approval
autoContinue automatically
defaultUse the repo's per-stage default policy

Recommended defaults:

  • ideation: human
  • baseline-digestion: auto
  • design: human
  • implementation: default
  • training: default
  • analysis: human
  • writing: human
  • review: human

Typical Flow

text
1. /research init
2. describe research direction
3. run autopilot
4. review outputs at human gates
5. use ralph or ultrawork when needed inside a stage
6. use /handoff before ending the session

Update

bash
cd ~/Claude/Harness/omr
git pull --ff-only origin main
npm install
npm run build
omr update-reconcile

Next

AutoResearch — Multi-agent Deep Learning Research System