claude-scholar README

The project's README from github.com/Galaxy-Dawn/claude-scholar. As one markdown file: README.md.

Claude Scholar Logo

Stars GitCode Stars Forks Last Commit License

Language: English | 中文 | 日本語

Supported Platforms: Claude Code | Codex CLI | Kimi Code CLI | OpenCode

Semi-automated research assistant for academic research and software development, especially for computer science and AI researchers. Supports Claude Code, Codex CLI, Kimi Code CLI, and OpenCode across literature review, coding, experiments, reporting, writing, and project knowledge management.

Branch note: the main branch is the Claude Code workflow. If you use Codex CLI, please see the codex branch. If you use Kimi Code CLI, please see the kimi branch. If you use OpenCode, please see the opencode branch.

Sponsors

Sponsor Description
APIMart Thanks to APIMart for sponsoring this project! APIMart is a low-cost API platform for AI image & video generation — GPT-Image-2 from $0.006/image, 160+ images per dollar. One async API covers both image and video: submit a task, get an ID, fetch results via polling or callback. Batch tens of thousands of images without timeouts, switch models without changing code. Pay-as-you-go with no monthly fee — sign up here to get started.
Kimi Open Source Friends Thanks to the Kimi team for their strong support of this project! Official links: Kimi Code · Platform CN · Platform Global.

Recent News

View older changelog
  • 2026-04-15: publication-chart-skill integrated into Claude Scholar — wrapped pubfig + pubtab into publication-chart-skill, added the skill to the repository, and connected it to Claude Scholar's analysis and writing boundaries so publication-grade figure/table work now has an explicit handoff route instead of being mixed into general analysis or prose skills.

  • 2026-03-31: Zotero smart-import workflow docs aligned — updated Claude Scholar's research-facing docs around the latest zotero-mcp public surface: zotero_add_items_by_identifier is now the default paper-import path, zotero_reconcile_collection_duplicates is the standard post-import cleanup step, source-aware PDF cascade behavior is documented more accurately, and public vs internal diagnostics are now clearly separated.

  • 2026-03-31: README onboarding refreshed — clarified that Claude Scholar is especially well-suited to computer science and AI researchers, added practical getting-started scenarios after installation, improved prerequisite and branch guidance, and made the “existing local md files must be manually merged” expectation much more explicit.

  • 2026-03-31: Installer and hook behavior tightened — the installer now preserves existing local CLAUDE.md while installing the repo-managed version as CLAUDE.scholar.md, and the default hook summaries were trimmed to reduce noisy temp-file / uncommitted-file output while keeping safer write-guard behavior.

  • 2026-03-31: Japanese documentation added — added Japanese docs for the main README plus AGENTS, MCP_SETUP, and OBSIDIAN_SETUP, so the OpenCode branch now has a more complete multilingual documentation surface.

  • 2026-02-25: Codex CLI support — added codex branch supporting OpenAI Codex CLI with config.toml, 40 skills, 14 agents, and sandbox security

  • 2026-02-23: Added setup.sh installer — backup-aware incremental updates for existing ~/.opencode, auto-backup opencode.jsonc, additive agent/mcp/permission/plugin merge

  • 2026-02-21: OpenCode support — Claude Scholar now supports OpenCode as an alternative CLI; switch to the opencode branch for OpenCode-compatible configuration

  • 2026-02-20: Bilingual docs — maintained English and Chinese entry documents for broader readability

  • 2026-02-15: Zotero MCP integration — added /zotero-review and /zotero-notes commands, updated research-ideation skill with Zotero integration guide, enhanced literature-reviewer agent with Zotero MCP support for automated paper import, collection management, full-text reading, and citation export

  • 2026-02-14: Hooks optimization — restructured security-guard to two-tier system (Block + Confirm), skill-forced-eval now groups skills into 6 categories with silent scan mode, session-start limits display to top 5, session-summary adds 30-day log auto-cleanup, stop-summary shows separate added/modified/deleted counts; removed deprecated shell scripts (lib/common.sh, lib/platform.sh)

  • 2026-02-11: Major update — added 10 new skills (research-ideation, results-analysis, citation-verification, review-response, paper-self-review, post-acceptance, daily-coding, frontend-design, ui-ux-pro-max, web-design-reviewer), 7 new agents, 8 research workflow commands, 2 new rules (security, experiment-reproducibility); restructured the main configuration docs; 89 files changed

  • 2026-01-26: Rewrote all Hooks to cross-platform Node.js; completely rewrote README; expanded ML paper writing knowledge base; merged PR #1 (cross-platform support)

  • 2026-01-25: Project open-sourced, v1.0.0 released with 25 skills (architecture-design, bug-detective, git-workflow, kaggle-learner, scientific-writing, etc.), 2 agents (paper-miner, kaggle-miner), 30+ commands (including SuperClaude suite), 5 Shell Hooks, and 2 rules (coding-style, agents)

Quick Navigation

Section What it helps with
Why Claude Scholar Understand the project positioning and target use cases.
Core Workflow See the end-to-end research pipeline from ideation to publication.
Quick Start Install Claude Scholar in full, minimal, or selective mode.
Getting Started Scenarios See a few realistic first-use scenarios after installation.
Integrations Learn how Zotero, Obsidian, and optional X promotion fit into the workflow.
Primary Workflows Browse the main research and development workflows.
Supporting Workflows See the background systems that strengthen the main workflow.
Documentation Jump to setup docs, configuration, and templates.
Citation Cite Claude Scholar in papers, reports, or project docs.

Why Claude Scholar

Claude Scholar is not an end-to-end autonomous research system that tries to replace the researcher.

Its core idea is simple:

human decision-making stays at the center; the assistant accelerates the workflow around it.

That means Claude Scholar is designed to help with the heavy, repetitive, and structure-sensitive parts of research — literature organization, note-taking, experiment analysis, reporting, and writing support — while still keeping the key judgments in human hands:

In other words, Claude Scholar is a semi-automated research assistant, not a “fully automated scientist.”

Who This Is For

Claude Scholar is especially well-suited to:

It can still help in other research settings, but its current workflow design is most aligned with computer science, AI, and adjacent computational research.

Core Workflow

Claude Scholar routes research work through a traceable path: question -> evidence -> experiment -> analysis -> claim -> writing. Each stage should preserve what is known, what is uncertain, and what decision should happen next.

Quick Start

Requirements

git clone https://github.com/Galaxy-Dawn/claude-scholar.git /tmp/claude-scholar
bash /tmp/claude-scholar/scripts/setup.sh

Windows: please use Git Bash or WSL to run the installer.

The installer is backup-aware and incremental-update friendly:

Important CLAUDE note: if you already maintain your own ~/.claude/CLAUDE.md or ~/.claude/CLAUDE.zh-CN.md, review ~/.claude/CLAUDE.scholar.md and ~/.claude/CLAUDE.zh-CN.scholar.md after installation and manually merge the Claude Scholar sections you want into your own files. Do not assume the sidecar files are applied automatically.

To update later:

cd /tmp/claude-scholar
git pull --ff-only
bash scripts/setup.sh

To uninstall later:

cd /tmp/claude-scholar
bash scripts/uninstall.sh

The installer now writes:

The uninstaller removes only files and settings entries recorded in that install state. It does not guess ownership from the current repo checkout.

Option 2: Minimal Installation

Install only a small research-focused subset:

git clone https://github.com/Galaxy-Dawn/claude-scholar.git /tmp/claude-scholar
mkdir -p ~/.claude/hooks ~/.claude/skills
cp /tmp/claude-scholar/hooks/*.js ~/.claude/hooks/
cp -r /tmp/claude-scholar/skills/ml-paper-writing ~/.claude/skills/
cp -r /tmp/claude-scholar/skills/research-ideation ~/.claude/skills/
cp -r /tmp/claude-scholar/skills/results-analysis ~/.claude/skills/
cp -r /tmp/claude-scholar/skills/results-report ~/.claude/skills/
cp -r /tmp/claude-scholar/skills/review-response ~/.claude/skills/
cp -r /tmp/claude-scholar/skills/writing-anti-ai ~/.claude/skills/
cp -r /tmp/claude-scholar/skills/git-workflow ~/.claude/skills/
cp -r /tmp/claude-scholar/skills/bug-detective ~/.claude/skills/

Post-install: minimal/manual install does not auto-merge settings.json; copy only the hooks or MCP entries you want from settings.json.template. If you already have your own ~/.claude/CLAUDE.md or ~/.claude/CLAUDE.zh-CN.md, also merge the relevant sections from this repo's Claude files into yours instead of blindly overwriting them.

Option 3: Selective Installation

Copy only the parts you need:

git clone https://github.com/Galaxy-Dawn/claude-scholar.git /tmp/claude-scholar
cd /tmp/claude-scholar

cp hooks/*.js ~/.claude/hooks/
cp -r skills/latex-conference-template-organizer ~/.claude/skills/
cp -r skills/architecture-design ~/.claude/skills/
cp agents/paper-miner.md ~/.claude/agents/
cp rules/coding-style.md ~/.claude/rules/
cp rules/agents.md ~/.claude/rules/

Post-install: selective/manual install does not auto-merge settings.json; copy only the hooks or MCP entries you actually want from settings.json.template. If you already have your own ~/.claude/CLAUDE.md or ~/.claude/CLAUDE.zh-CN.md, merge the relevant sections from this repo's Claude files into yours instead of blindly overwriting them.

Option 4: Plugin Marketplace Installation

Step 1: Install the Plugin

/plugin marketplace add Galaxy-Dawn/claude-scholar
/plugin install claude-scholar@claude-scholar

This auto-loads all skills, commands, agents, and hooks. During installation, you can choose the scope: user (all projects) or project (single project).

Step 2: Install Rules (Required)

Claude Code plugins cannot distribute rules automatically. Install them manually:

git clone https://github.com/Galaxy-Dawn/claude-scholar.git /tmp/claude-scholar

# User-level (all projects)
mkdir -p ~/.claude/rules
cp /tmp/claude-scholar/rules/*.md ~/.claude/rules/

# Or project-level (current project only)
mkdir -p .claude/rules
cp /tmp/claude-scholar/rules/*.md .claude/rules/

Post-install: plugin installation does not auto-load CLAUDE.md or configure settings.json; if you already have your own ~/.claude/CLAUDE.md or ~/.claude/CLAUDE.zh-CN.md, merge the relevant Claude Scholar sections into yours instead of assuming the plugin applies them automatically. If you need Zotero MCP or other integrations, see the Integrations section for manual setup.

Getting Started Scenarios

After installation, the simplest way to begin is to describe your task in natural language. You do not need to memorize the whole system first. Below are a few realistic starting points.

1. Start a New Research Topic

You can say:

Help me start research on [your topic]. I want a literature-grounded plan, the key

claude-scholar (Galaxy-Dawn/claude-scholar)

Searching Database…

这是什么?Claude Scholar 是一款半自动化的研究助手,面向学术研究和软件开发,尤其为计算机科学和人工智能研究人员量身打造。它按流程把工作分派到构思、文献综述、编码、实验、报告以及写作与发表等环节,并可接入 Claude Code、Codex CLI、Kimi Code CLI 和 OpenCode。
它是独立的应用程序,还是我要添加到编码代理里的一组技能?它不是独立的应用程序,而是一组技能、代理、命令、钩子和规则,由安装程序放入你现有的 Claude Code(或 Codex CLI / Kimi Code CLI / OpenCode)配置文件夹中。
我需要先安装什么?至少需要 Claude Code 和 Git。Python + uv、Zotero(配合 zotero-mcp 服务器)以及 Obsidian 是可选的,仅在使用 Python 工具、导入文献或知识库工作流时才需要。
它能完全替我自动完成研究吗?不能,它明确定位为半自动化工具。它负责处理重复性的文献整理、笔记、分析和写作辅助工作,但决定研究哪些问题、哪些论文重要以及发表什么内容,仍然由人来决定。
它主要面向谁?主要面向计算机科学和人工智能/机器学习研究人员、研究工程师,以及在文献综述、编码、实验和论文写作之间切换的研究生;对非计算机类的研究领域适配度较低。
它如何与 Zotero 连接?通过配套的 zotero-mcp 服务器实现:/zotero-review、/zotero-notes 等命令让代理能够通过标识符导入论文、读取全文、管理收藏夹,并直接从 Zotero 导出引用。
经过验证的研究结论最终去哪里?它们会被导入一个以项目为范围的 Obsidian 知识库(vault),其中按 Sources、Knowledge、Experiments、Results、Writing、Daily 和 Maps 文件夹组织。可长期成立的论断会先从论文笔记转入知识库,成为可复用的知识,然后才进入草稿。
pubfig 和 pubtab 是什么?它们是封装进 publication-chart-skill 的配套 Python 包:pubfig 生成达到发表标准的科学图表,pubtab 生成可导出为 Excel/LaTeX 的发表级表格,覆盖论文中图表的最终质量检查阶段。
我能用 Codex CLI 或 Kimi Code CLI 代替 Claude Code 吗?可以。主分支是 Claude Code 工作流,另有针对 Codex CLI、Kimi Code CLI 和 OpenCode 的独立分支,每个分支都有各自的安装文档。
Size
9.4 MB
Stars
5.8K
Age
8mo
Commits · 90 Days