Skip to content

About

Proposal-first research, grounded in evidence. ScholarClaw searches the real literature, stress-tests novelty, orchestrates review and revision, and helps turn rough ideas into stronger, more defensible papers.

Topics

Resources

Stars

11 stars

Watchers

0 watching

Forks

Repository files navigation

ScholarClaw logo

Türkçe / English

ScholarClaw

A self-critical AI research colleague for scientists.

Version 0.5.0 22 stages proposal.md workflow objectivity guarded search intent planning MIT license

Objectivity Guardrails release: proposal-file workflow, structured search intent planning, neutral assumption framing, and Stage 9 objectivity review.

Proposal-first research, grounded in evidence.

Terminal-first today. Full end-to-end web interface coming soon.

ScholarClaw helps you turn a research proposal into a better-grounded experiment plan and paper draft.

You give it a short research proposal in proposal.md. It searches the literature, checks whether the idea looks novel, finds weak spots, plans experiments, and writes structured research artifacts you can inspect.

Use it when you want a research assistant that challenges the idea before writing the final paper.

What It Does

ScholarClaw helps researchers:

  • search the literature that actually matters for the field
  • see whether an idea is novel, crowded, or still unclear
  • strengthen proposals before time is spent on execution
  • keep the work grounded in evidence from the start
  • carry the work forward through execution, review, revision, and publication when the foundation is strong

Start Here

Step-by-step guide (recommended): English · Türkçe

That guide explains, in plain language, how to run ScholarClaw, what each phase produces, and where to open your results.

New here? Read this first

ScholarClaw runs in your Terminal (the command-line app on Mac or Linux). You do not need to write code. You copy a few commands, press Enter, and then read the HTML reports it creates.

What you do:

  1. Install ScholarClaw once (setup below).
  2. Edit proposal.md with your research idea.
  3. Open the HTML files in your web browser and read the reports.

How the work is organized:

Term Plain meaning
Run One full attempt at your research proposal. All outputs go into one folder.
Bucket A chapter of work. Most people run one bucket at a time, not all 22 steps at once.
Stage One step inside a bucket (for example: search papers, write hypotheses, plan experiments).
Gate A pause where ScholarClaw waits for you to approve before continuing.
HTML report A readable web page you open in Chrome, Safari, or Firefox. Start here.

The five buckets (run these in order):

Bucket What it does Stages
proposal Literature review → hypotheses → experiment plan 1–9
execution Prepare code → run experiments → analyze results 10–13
publication Write and polish the paper 14–20
review Simulated external peer review 21
revision Apply review feedback 22

Buckets vs single stages: Use a bucket when you want a whole phase (for example, everything up to the experiment plan). Use one stage only when you need to rerun a single step after fixing something.

Your first run (copy-paste):

# 1. Use the sample proposal, or edit proposal.md with your own research idea

# 2. Proposal phase — literature, hypotheses, experiment plan
scholarclaw run -c config.yaml --topic-file proposal.md --bucket proposal

# 3. After you approve Stage 9 (see below), run experiments
scholarclaw run -c config.yaml --output artifacts/<your-run-folder> --bucket execution

The repository includes a sample proposal.md. Read it first to see the kind of input ScholarClaw expects: a researcher-style brief with a problem, research questions, hypotheses, scope, candidate datasets, method, metrics, expected contribution, and reproducibility notes.

Replace the contents of proposal.md with your own proposal when you are ready. Replace artifacts/<your-run-folder> with the folder ScholarClaw printed when the first run finished (for example artifacts/rc-20260523-153055-23e65e).

Where to read results: Open these files in your browser (double-click, or drag into Chrome/Safari):

  • artifacts/<your-run-folder>/stage-01/goal.html — research goal
  • stage-08/hypotheses.html — hypotheses
  • stage-09/experiment_plan.html — experiment plan (review this before continuing)

Before Stage 10: ScholarClaw pauses at Stage 9 for your approval. Read experiment_plan.html, including the Objectivity Review. If it looks good, either rerun Stage 9 with --auto-approve, or approve manually.

What to Put in proposal.md

Use plain research language. You do not need to write code.

Good proposal input usually includes:

  • the research problem
  • why the problem matters
  • research questions
  • hypotheses or claims you want tested
  • scope and limits
  • candidate datasets or sources
  • proposed methods or comparison groups
  • metrics for success
  • risks, limitations, and reproducibility requirements

It is okay if your wording is optimistic, skeptical, or incomplete. ScholarClaw now treats the proposal as claims to test, not conclusions to confirm. It creates objectivity artifacts such as proposal_objectivity.json, proposal_assumption_frame.json, and objectivity_contract.json, then shows plain-language objectivity warnings in the HTML reports.

For literature search, ScholarClaw also converts your proposal into short, inspectable search intents in proposal_search_intent.json. Long prose, numbered comparison lists, and full-sentence sections stay in the proposal for context, but they are not pasted directly into browser search URLs.

What You Need

  • A Mac or Linux computer (Windows via WSL also works)
  • Python 3.11 or newer (download)
  • An AI API key — we recommend OpenRouter (sign up, create a key, paste it below)
  • Optional: Playwright, only if you want browser-based paper search

1. Open Terminal and go to the project folder

On Mac: open Terminal, then:

cd path/to/AutoResearchClaw

Replace path/to/AutoResearchClaw with where you downloaded the project.

2. Create a Python environment

This keeps ScholarClaw’s dependencies isolated. Run once:

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip

After this, your Terminal prompt may show (.venv) — that means the environment is active.

3. Install ScholarClaw

Standard install (enough for most users):

pip install -e .

Optional — only if you want automated browser paper search:

pip install -e ".[browser]"
playwright install

4. Create your config file

cp my.config.yaml config.yaml

Open config.yaml in any text editor. For OpenRouter (easiest start), it should look like:

llm:
  mode: "openrouter"
  provider: "openrouter"
  api_key_env: "OPENROUTER_API_KEY"
  primary_model: "anthropic/claude-sonnet-4"

Set your API key in Terminal (replace with your real key):

export OPENROUTER_API_KEY="your-key-here"

You must run this export command in the same Terminal window each time you open a new session, or add it to your shell profile.

For a local AI server (LM Studio) instead of OpenRouter:

llm:
  mode: "lmstudio"
  provider: "lmstudio"
  base_url: "http://127.0.0.1:1234/v1"
  primary_model: "local-model-name"

5. Check that everything works

scholarclaw validate -c config.yaml
scholarclaw doctor -c config.yaml

If both commands finish without errors, you are ready to run.

6. Run your proposal

Recommended — proposal bucket only (stages 1–9):

scholarclaw run -c config.yaml --topic-file proposal.md --bucket proposal

Skip approval prompts (useful for unattended runs):

scholarclaw run -c config.yaml --topic-file proposal.md --bucket proposal --auto-approve

Run one specific step only (after a prior run exists):

scholarclaw run -c config.yaml --output artifacts/your-run-folder --only-stage EXPERIMENT_DESIGN

Continue after interruption:

scholarclaw run -c config.yaml --output artifacts/your-run-folder --resume --bucket proposal

7. Read your results

When a run finishes, ScholarClaw prints a folder path like artifacts/rc-20260523-153055-23e65e/.

Open the HTML files below in your browser. You do not need to understand JSON or YAML unless you are debugging.

scholarclaw report artifacts/<your-run-folder>

Most useful reports to open first:

Open this file What you get
stage-01/goal.html Clear research goal
stage-05/screening_report.html Which papers were kept
stage-08/hypotheses.html Testable hypotheses
stage-09/experiment_plan.html Full experiment plan and Objectivity Review — read before approving
stage-10/resource_plan.html Time and compute estimates (after execution bucket)
stage-13/decision_report.html What to do next after experiments

HTML Report Preview

Proposal bucket stages 1–9 (sample run):

Stage 1: Goal Stage 2: Problem Tree Stage 3: Search Strategy
Stage 1 goal HTML report Stage 2 problem tree HTML report Stage 3 search strategy HTML report
Stage 4: Literature Collect Stage 5: Literature Screen Stage 6: Knowledge Extract
Stage 4 collection report HTML Stage 5 screening report HTML Stage 6 knowledge cards HTML
Stage 7: Synthesis Stage 8: Hypotheses Stage 9: Experiment Design
Stage 7 synthesis report HTML Stage 8 hypotheses HTML report Stage 9 experiment plan HTML report

Key Capabilities

  • 22-stage research pipeline from idea to proposal, experiments, paper draft, review, and revision
  • Literature retrieval through APIs and optional browser automation
  • LLM-assisted connector routing with probe validation, prior-run source feedback, and deterministic OpenAlex/Semantic Scholar/arXiv fallback
  • Evidence quality checks so weak or off-topic papers are easier to spot
  • Novelty checking, citation verification, and citation relevance pruning
  • Objectivity guardrails that treat proposal wording as claims to test, not truth to confirm
  • Structured proposal search intent planning with source-safe browser queries and quality gates
  • Neutral assumption frames and objectivity contracts before hypotheses and experiment design
  • Experiment planning, benchmark planning, and result analysis
  • BenchmarkAgent experiment-task gating (structured evaluation signals, not ML-only keywords) so off-domain datasets and baselines are rejected before injection
  • DatasetVerifier provenance and accessibility checks for benchmark candidates (curated registry, HuggingFace Hub, or explicit metadata)
  • Stage 9 validation warnings, Objectivity Review, and gate readiness surfaced in experiment_plan.html and proposal_decision_state.json
  • Stage-specific model routing and checkpoint/resume support
  • Single-file HTML reports for important review surfaces, with humanized metric and ablation labels
  • Data-shape driven figure planning — chart families follow result structure (conditions, training history, matrices), not topic keywords

Detailed Feature Comparison

Three-way view against upstream AutoResearchClaw and ScienceClaw.

ScholarClaw AutoResearchClaw ScienceClaw

ScholarClaw AutoResearchClaw ScienceClaw
Primary model 22-stage pipeline 23-stage pipeline OpenClaw agent + 285 skills
End-to-end workflow proposal.md → buckets → artifacts Stage-oriented runs Chat / web gateway + SCIENCE.md
Run scopes 5 buckets + single-stage CLI Stage-oriented runs Conversational tasks
Browser scholarly targets 7+ registered sites Shared agent path OpenClaw path
ScholarClaw-only vs ARC 32 — —
ScholarClaw-only vs SC (E2E) 26 — —

Legend: ✅ supported · ❌ not first-class today · ⚠️ partial or different model · ⭐ ScholarClaw differentiator · 🔬 ScienceClaw differentiator

Pipeline & workflow

Feature ScholarClaw AutoResearchClaw ScienceClaw Notes
Staged research pipeline ✅ ✅ ❌ ScholarClaw / ARC: fixed stages; ScienceClaw: skill-driven agent
⭐ Bucketed execution ✅ ❌ ❌ proposal, execution, publication, review, revision
Dedicated external review bucket ✅ ❌ ❌ Post-publication review as its own scope
Dedicated external revision bucket ✅ ❌ ❌ Follow-up revision separated from publication
One-stage and bucket-scoped execution ✅ ❌ ❌ --only-stage and --bucket as first-class CLI
Gate stages with stop / approve ✅ ⚠️ ❌ ScholarClaw: literature (5), experiment plan (9), quality (18)
proposal.md first-class intake ✅ ❌ ❌ Original proposal preserved; downstream stages test claims
One command through experiment plan ✅ ⚠️ ❌ scholarclaw run --bucket proposal
Checkpoint and resume ✅ ✅ ⚠️ ScienceClaw: cross-session chat memory, not per-stage resume

Literature & browser retrieval

Feature ScholarClaw AutoResearchClaw ScienceClaw Notes
⭐ Agentic browser retrieval ✅ ✅ ⚠️ ScholarClaw / ARC: first-class path; ScienceClaw: via OpenClaw
OpenAlex / Semantic Scholar / arXiv ✅ ✅ ⚠️ ScienceClaw: DB skills, not the same pipeline backbone
⭐ LLM-assisted connector routing ✅ ❌ ❌ Classifier intent + probe quality + prior outcomes; no static domain keywords
Connector capability registry ✅ ❌ ❌ Per-connector scope, cost tier, runtime/browser support in routing trace
PubMed / Europe PMC connectors ✅ ❌ ✅ ScienceClaw: deep PubMed skills; ScholarClaw: pipeline connectors
Browser-first literature mode ✅ ❌ ❌ Browser can be the default collection path
Headless browser mode ✅ ❌ ❌ Visible or headless automation
Explicit browser target registry ✅ ❌ ❌ Semantic Scholar, arXiv, Elsevier, Springer, IEEE, Google Scholar, Web of Science
Year window controls ✅ ❌ ❌ Presets plus start_year / end_year
Retrieval depth controls ✅ ❌ ⚠️ ScholarClaw: fast→exhaustive; ScienceClaw: Quick→Systematic tool tiers
Search hardening and deduplication ✅ ✅ ⚠️ ScholarClaw adds bucketed Stage 1 query plans
🔬 Multi-database academic skills (25+) ⚠️ ❌ ✅ UniProt, KEGG, World Bank, ChEMBL, … via MCP skills
🔬 Long-session literature depth protocol ⚠️ ❌ ✅ SCIENCE.md minimum tool-call enforcement
Zero-hallucination citation rule ✅ ✅ ✅ Tool-backed citations; no invented DOIs

Proposal intelligence

Feature ScholarClaw AutoResearchClaw ScienceClaw Notes
Proposal / goal grounding ✅ ❌ ❌ Early artifacts tied to verified evidence and gap reports
⭐ Structured search intent ✅ ❌ ❌ proposal_search_intent.json with source-safe browser queries
⭐ Objectivity guardrails ✅ ❌ ❌ Original proposal preserved; neutral assumptions + objectivity contract

Literature quality & synthesis

Feature ScholarClaw AutoResearchClaw ScienceClaw Notes
Multiple screening modes ✅ ❌ ❌ deterministic, llm, hybrid
Screening gate with HTML report ✅ ❌ ❌ Stage 5 blocks weak literature before synthesis
Research protocol trace (stages 3–6) ✅ ❌ ❌ research_protocol_trace.json audits routing and provenance
Collection quality gate ✅ ❌ ❌ Semantic fit, domain anchors, explicit drop reasons
Knowledge-extract quality diagnostics ✅ ❌ ❌ knowledge_quality.json before synthesis
Novelty and positioning checks ✅ ❌ ❌ Positioning support is explicit in the workflow

Experiments & benchmarks

Feature ScholarClaw AutoResearchClaw ScienceClaw Notes
BenchmarkAgent ✅ ✅ ❌ Benchmark-aware experiment support in pipeline
⭐ Experiment design gate + approval ✅ ⚠️ ❌ Stage 9 experiment_plan.html + Objectivity Review
BenchmarkAgent experiment gating ✅ ❌ ❌ Structured evaluation signals (benchmark, dataset, ablation); not ML-only keywords
Dataset provenance verification ✅ ❌ ❌ DatasetVerifier rejects datasets without access path
Experiment plan warnings in HTML ✅ ❌ ❌ Stage 9 surfaces validation, objectivity, and dataset checks
Experiment scaffold + resource plan ✅ ⚠️ ❌ Stage 10 code tree, GPU budget, task order
Run → analyze → proceed/refine/pivot ✅ ⚠️ ⚠️ Stages 11–13 as connected artifacts
Run code / notebooks via agent ⚠️ ⚠️ ✅ ScienceClaw skills for interactive analysis sessions

Publication, review & revision

Feature ScholarClaw AutoResearchClaw ScienceClaw Notes
Publication bucket (write → figures → review) ✅ ⚠️ ⚠️ ScholarClaw: stages 14–17; ScienceClaw: LaTeX / writing skills
Citation verification ✅ ✅ ✅ Multi-layer verification, not raw generation
Citation relevance pruning ✅ ✅ ⚠️ Relevance-aware cleanup in pipeline
Publication-aware writing ✅ ✅ ⚠️ ScholarClaw extends toward publication-family awareness
Custom LaTeX template path ✅ ❌ ⚠️ User-provided template path supported
FigureAgent ✅ ✅ ⚠️ Figure-generation paths
⭐ Data-shape driven figure planning ✅ ❌ ❌ Chart families from result structure, not domain keyword tables
Parallel reviewer workflows ✅ ✅ ❌ Dedicated peer-review stage with structured outputs
Resumable review manifests ✅ ❌ ❌ Finished reviews can be reused
Structured revision planning ✅ ❌ ❌ Stage 22 plans responses from editor / reviewer outputs
🔬 PRISMA / grant / meta-analysis skills ⚠️ ❌ ✅ ScienceClaw: skill templates for common deliverables

Operations & interface

Feature ScholarClaw AutoResearchClaw ScienceClaw Notes
Stage-specific model routing ✅ ❌ ❌ Different models per stage group in YAML
LM Studio / Ollama local path ✅ ❌ ⚠️ Documented OpenAI-compatible local operation
ACP-compatible execution ✅ ✅ ⚠️ ACP execution paths
Persisted sub-stage recovery ✅ ❌ ❌ Finer-grained sub-stage state and review artifacts
validate / doctor / report ✅ ❌ ❌ Config validation, health checks, run reports
Cross-run learning ✅ ✅ ✅ ScholarClaw: EvolutionStore; ScienceClaw: skill evolution + LanceDB
HTML companion artifacts per stage ✅ ❌ ⚠️ Decision surfaces (goal.html, experiment_plan.html, …)
🔬 Web research gateway UI ❌ ❌ ✅ ScholarClaw is terminal-first; web UI planned
🔬 Self-evolving skills (285+) ❌ ❌ ✅ Runtime SKILL.md generation without redeploy
🔬 Cross-session research memory ⚠️ ❌ ✅ LanceDB + temporal decay across projects
🔬 1-hour agent sessions + heartbeat ❌ ❌ ✅ Built for multi-hour literature / analysis sessions

Comparison reflects the public feature surfaces of AutoResearchClaw and ScienceClaw at the time of this release.

Workflow Philosophy

ScholarClaw is for researchers who want help thinking more clearly before they commit to a research direction.

From early idea to proposal, and from execution to publication, the focus is not just speed.

The focus is better research judgment, earlier in the process.

Outputs and Artifacts

Each run writes to artifacts/<run-id>/ (or your --output path). Every stage gets its own folder: stage-01/, stage-02/, …

How to read outputs

Format Use when you want to…
HTML (.html) Read, share, or approve — open in any browser
JSON / YAML Inspect gate state, quality scores, or machine checks
Markdown (.md) Source text that downstream stages consume
Folders (cards/, runs/, experiment/) Raw structured data or code scaffolds

Legend: 🛑 approval gate · 📄 HTML report · 📦 machine-readable only

Start here (proposal bucket)

Open these after scholarclaw run --bucket proposal:

Stage Open in browser What it tells you
01 Topic Init stage-01/goal.html Research goal, early evidence, Objectivity Review
05 Literature Screen 🛑 stage-05/screening_report.html Which papers survived screening — gate before synthesis
08 Hypotheses stage-08/hypotheses.html Testable hypotheses and novelty signals
09 Experiment Design 🛑 stage-09/experiment_plan.html Full plan + Objectivity Review — approve before execution

Also check stage-09/proposal_decision_state.json for gate readiness and validation warnings.

Full catalog

proposal — stages 1–9

# Stage Read first Key machine files Purpose
01 Topic Init 📄 goal.html proposal_brief.json, proposal_search_intent.json, proposal_objectivity.json, objectivity_contract.json, goal_references.bib Ground the proposal; preserve original claims; plan source-safe search
02 Problem Decompose 📄 problem_tree.html problem_tree.json, topic_evaluation.json Break the goal into sub-questions and evidence gaps
03 Search Strategy 📄 search_strategy.html search_plan.yaml, queries.json, research_protocol_trace.json Query plan, sources, and coverage per sub-question
04 Literature Collect 📄 collection_report.html candidates.jsonl, collection_quality.json, references.bib Collected papers, drop reasons, fix list before screening
05 Literature Screen 🛑 📄 screening_report.html shortlist.jsonl, screening_quality.json Shortlist gate — weak literature stops the run here
06 Knowledge Extract 📄 knowledge_cards.html cards/, knowledge_quality.json Structured cards per paper — methods, findings, limits
07 Synthesis 📄 synthesis_report.html synthesis.md, synthesis_quality.json Topic clusters, gaps, contradictions, directions
08 Hypothesis Generation 📄 hypotheses.html hypotheses.md, novelty_report.json, baseline_gap_report.json Falsifiable hypotheses with evidence scope
09 Experiment Design 🛑 📄 experiment_plan.html exp_plan.yaml, proposal_decision_state.json Baselines, metrics, datasets, risks — gate before code

execution — stages 10–13

# Stage Read first Key machine files Purpose
10 Implementation Prep 📄 resource_plan.html experiment/, experiment_spec.md, schedule.json Code scaffold, task order, GPU budget
11 Experiment Run 📄 run_report.html runs/ Run status, metrics, logs, reproducibility files
12 Iterative Refine — refinement_log.json, experiment_final/ Edit–run–evaluate loops until convergence
13 Analysis Decision 📄 analysis.html, decision_report.html decision_structured.json Metrics summary and proceed / refine / pivot decision

publication — stages 14–20

# Stage Read first Key machine files Purpose
14 Paper Outline — outline.md, publication_profile.json Section plan and venue fit
15 Paper Draft — paper_draft.md, claim_evidence_ledger.json Full draft with claim–evidence trace
16 Peer Review 📄 peer_review_report.html reviews.md Simulated reviewer feedback
17 Paper Revision — paper_revised.md Draft updated from review comments
18 Quality Gate 🛑 — quality_report.json Release threshold — may send work back for revision
19 Export and Archive — paper_final.md, bundle_index.json, archive.md Final package and reproducibility bundle
20 Citation Verify — verification_report.json, references_verified.bib Citation and bibliography verification

review + revision — stages 21–22

# Stage Read first Key machine files Purpose
21 External Review — review_panel.json, reviewers/, editor_decision.json Multi-reviewer panel and editor-style decision
22 External Revision — revision_plan.json, response_to_reviewers.md, paper_revised_external.md Response letter and revised submission

HTML reports are self-contained (inline CSS). JSON, YAML, and Markdown remain the source of truth for downstream stages.

Generate a navigable index from any completed run:

scholarclaw report artifacts/<run-id>

Why It Exists

Too many research workflows jump straight from idea to output. They summarize quickly, generate confidently, and move on before the core questions have been tested:

  • Has this already been done?
  • Is the idea truly different, or just phrased differently?
  • What would make the contribution stronger?
  • What would a serious reviewer challenge?

ScholarClaw is designed to stay with those questions longer, because that is where better research begins.

It is also designed to ask those questions in the right research context, so ideas are judged against the literature that actually matters for the field.

CLI Highlights

  • scholarclaw run for full or bucket-scoped execution
  • scholarclaw list-stages to inspect the pipeline before running it
  • scholarclaw validate to validate config early
  • scholarclaw doctor for environment and configuration health checks
  • scholarclaw report to generate a readable summary from a completed run

Current Positioning

ScholarClaw is not meant to be just another paper generator.

It is shaped as a research partner that challenges ideas, surfaces evidence, and helps build stronger work from the beginning.

It is especially useful when you want to:

  • map ideas against the literature that matters for the field
  • identify novelty risks before time is spent on execution
  • suggest stronger positioning when an idea is too close to prior work
  • surface weak spots, missing comparisons, and likely reviewer objections early
  • help shape proposals with clearer positioning and higher ambition
  • keep the work grounded in evidence instead of confident but unsupported claims
  • support the path from proposal to experiments and paper when the foundation is strong

Status

ScholarClaw is currently in active development.

The direction is clear: better research judgment earlier, stronger evidence throughout, and more defensible work by the time a paper is written.

Coming Soon

  • Full-featured web interface that starts with entering a research idea and carries the workflow all the way to a produced paper.
  • End-to-end UI for configuring runs, monitoring stage progress, browsing artifacts, and managing long-running review, revision, and approval workflows without living in the terminal.

Foundation

ScholarClaw builds on the foundation of AutoResearchClaw and is evolving into its own more focused, evidence-grounded research product.

About

Proposal-first research, grounded in evidence. ScholarClaw searches the real literature, stress-tests novelty, orchestrates review and revision, and helps turn rough ideas into stronger, more defensible papers.

Topics

Resources

Stars

11 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages