Skip to content
Back to search

claude-paper

SkillWorks with Claude CodeGitHub

πŸ“– Cross-agent research paper toolkit for Claude Code, Codex, OpenCode, and DeepSeek Harnessβ€”quick summaries, deep study materials, code demos, and a local web viewer.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/alaliqing--claude-paper/badge.svg)](/listings/alaliqing--claude-paper)

HTML

<a href="/listings/alaliqing--claude-paper"><img src="/api/listings/alaliqing--claude-paper/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Install all supported agents

Install Claude Code, Codex, OpenCode, and DeepSeek Harness with one commandβ€”no repository clone required:

npx --yes @zlzliqing/claude-paper@latest install

The default `all` target covers all four agents. For Claude Code, the installer uses the official Claude CLI to register the package-local marketplace and install or update the user-scoped plugin. For the other agents, it installs the shared Skills and OpenCode commands where applicable.

Install only selected agents when needed:

npx --yes @zlzliqing/claude-paper@latest install --target claude-code
npx --yes @zlzliqing/claude-paper@latest install --target codex
npx --yes @zlzliqing/claude-paper@latest install --target opencode
npx --yes @zlzliqing/claude-paper@latest install --target deepseek-harness

Upgrade an existing installation with the same formal distribution channel:

# Upgrade all supported agents
npx --yes @zlzliqing/claude-paper@latest upgrade

# Keep upgrading only the agents selected during installation
npx --yes @zlzliqing/claude-paper@latest upgrade --target codex,opencode

The default upgrade target is `all`. If the existing installation only targets selected agents, pass the same `--target` list during upgrade so no additional agent integrations are added.

The npm package copies its packaged plugin runtime to the user data directory, installs the generated compatibility Skills in `~/.agents/skills/` when a shared-Skills host is selected, and adds OpenCode commands when OpenCode is selected. It initializes `~/claude-papers/` only when the library does not already exist. Restart the selected agents after installation or upgrade.

Claude Code Marketplace-only alternative

If you only use Claude Code, you can still install directly from its marketplace:

/plugin marketplace add alaliqing/claude-paper
/plugin install claude-paper

Claude Paper currently runs through Agent Skills; no separate MCP server installation or configuration is required.

System Requirements

- **Node.js**: 20.19.x, or 22.12.0 and higher - **npm**: Comes with Node.js - **Agent host**: Claude Code, Codex, OpenCode, or DeepSeek Harness - **Claude Code CLI**: Required when `all` or `claude-code` is selected - **poppler-utils**: For PDF image extraction (install via system package manager) - **macOS**: `brew install poppler` - **Ubuntu/Debian**: `sudo apt-get install poppler-utils` - **Arch Linux**: `sudo pacman -S poppler`

---

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json Β· Manifest Β· 21 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. {
  2. "$schema": "https://anthropic.com/claude-code/marketplace.schema.json",
  3. "name": "claude-paper",
  4. "description": "A plugin for studying research papers with automated material generation and code demonstrations",
  5. "owner": {
  6. "name": "alaliqing"
  7. },
  8. "plugins": [
  9. {
  10. "name": "claude-paper",
  11. "version": "1.2.1",
  12. "description": "A plugin for studying research papers with automated material generation, code demos, and a web viewer",
  13. "author": {
  14. "name": "alaliqing"
  15. },
  16. "category": "development",
  17. "source": "./plugin",
  18. "homepage": "https://github.com/alaliqing/claude-paper"
  19. }
  20. ]
  21. }
README.md Β· README Β· 344 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <div align="center">
  2. # Claude Paper
  3. **Transform research papers into comprehensive learning environments**
  4. [English](README.md) | [δΈ­ζ–‡](README.zh-CN.md)
  5. [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
  6. [![Node Version](https://img.shields.io/badge/node-20.19.x_%7C_22.12%2B-brightgreen)](https://nodejs.org)
  7. [![Agent Skills](https://img.shields.io/badge/Agent_Skills-Compatible-purple)](https://agentskills.io)
  8. A research-paper learning plugin for **Claude Code, Codex, OpenCode, and DeepSeek Harness**. It preserves the same study workflow, generated materials, code demonstrations, and interactive web viewer across supported agents.
  9. <table>
  10. <tr>
  11. <td align="center">
  12. <img src="assets/screenshot1.png" alt="Library View" width="100%"/>
  13. <br/>
  14. <sub>Library View - Browse and search your paper collection</sub>
  15. </td>
  16. <td align="center">
  17. <img src="assets/screenshot2.png" alt="Reading View" width="100%"/>
  18. <br/>
  19. <sub>Reading View - Study papers with rich formatting and math support</sub>
  20. </td>
  21. </tr>
  22. </table>
  23. </div>
  24. ## Features
  25. - **Automatic PDF parsing** - Extract title, authors, abstract, links, and complete paper text
  26. - **Context-safe previews** - Save complete text to `paper.txt` while keeping a 50k preview in metadata
  27. - **Code repository detection** - Automatically finds GitHub, arXiv, CodeOcean links
  28. - **Quick paper summaries** - Screen a paper with a concise 300–500 word overview before a deep study
  29. - **Adaptive learning materials** - Generates README, summary, insights, Q&A based on paper complexity
  30. - **Code demonstrations** - Clean implementations with Jupyter notebooks and original code integration
  31. - **Interactive web viewer** - Nuxt.js interface with math equation support (KaTeX)
  32. - **Intelligent assessment** - Difficulty levels and paper type detection for adaptive content generation
  33. ---
  34. ## Quick Start
  35. ### Install all supported agents
  36. Install Claude Code, Codex, OpenCode, and DeepSeek Harness with one commandβ€”no repository clone required:
  37. ```bash
  38. npx --yes @zlzliqing/claude-paper@latest install
  39. ```
  40. The default `all` target covers all four agents. For Claude Code, the installer uses the official Claude CLI to register the package-local marketplace and install or update the user-scoped plugin. For the other agents, it installs the shared Skills and OpenCode commands where applicable.
  41. Install only selected agents when needed:
  42. ```bash
  43. npx --yes @zlzliqing/claude-paper@latest install --target claude-code
  44. npx --yes @zlzliqing/claude-paper@latest install --target codex
  45. npx --yes @zlzliqing/claude-paper@latest install --target opencode
  46. npx --yes @zlzliqing/claude-paper@latest install --target deepseek-harness
  47. ```
  48. Upgrade an existing installation with the same formal distribution channel:
  49. ```bash
  50. # Upgrade all supported agents
  51. npx --yes @zlzliqing/claude-paper@latest upgrade
  52. # Keep upgrading only the agents selected during installation
  53. npx --yes @zlzliqing/claude-paper@latest upgrade --target codex,opencode
  54. ```
  55. The default upgrade target is `all`. If the existing installation only targets selected agents, pass the same `--target` list during upgrade so no additional agent integrations are added.
  56. The npm package copies its packaged plugin runtime to the user data directory, installs the generated compatibility Skills in `~/.agents/skills/` when a shared-Skills host is selected, and adds OpenCode commands when OpenCode is selected. It initializes `~/claude-papers/` only when the library does not already exist. Restart the selected agents after installation or upgrade.
  57. ### Claude Code Marketplace-only alternative
  58. If you only use Claude Code, you can still install directly from its marketplace:
  59. ```bash
  60. /plugin marketplace add alaliqing/claude-paper
  61. /plugin install claude-paper
  62. ```
  63. Claude Paper currently runs through Agent Skills; no separate MCP server installation or configuration is required.
  64. ### System Requirements
  65. - **Node.js**: 20.19.x, or 22.12.0 and higher
  66. - **npm**: Comes with Node.js
  67. - **Agent host**: Claude Code, Codex, OpenCode, or DeepSeek Harness
  68. - **Claude Code CLI**: Required when `all` or `claude-code` is selected
  69. - **poppler-utils**: For PDF image extraction (install via system package manager)
  70. - **macOS**: `brew install poppler`
  71. - **Ubuntu/Debian**: `sudo apt-get install poppler-utils`
  72. - **Arch Linux**: `sudo pacman -S poppler`
  73. ---
  74. ## Usage
  75. ### Quickly Summarize a Research Paper
  76. Ask the selected agent for a quick summary, or use the host command directly:
  77. ```bash
  78. # Claude Code
  79. /claude-paper:summary /path/to/paper.pdf
  80. # OpenCode
  81. /claude-paper-summary /path/to/paper.pdf
  82. ```
  83. In Codex or DeepSeek Harness, ask for a quick paper summary or explicitly load the `claude-paper-summary` Skill. This creates `quick-summary.md` while preserving the PDF, complete `paper.txt`, and metadata in the shared paper library.
  84. ### Study a Research Paper
  85. Simply ask the selected agent to study a paper:
  86. ```
  87. Help me study the paper at ~/Downloads/attention-is-all-you-need.pdf
  88. ```
  89. You can also use URLs:
  90. ```
  91. # Direct PDF URL
  92. Help me study the paper at https://arxiv.org/pdf/1706.03762.pdf
  93. # arXiv abstract URL (automatically converted to PDF)
  94. Help me study the paper at https://arxiv.org/abs/1706.03762
  95. ```
  96. The agent will automatically trigger the study workflow and:
  97. 1. Parse the PDF and extract metadata
  98. 2. Analyze paper complexity and type
  99. 3. Generate adaptive learning materials
  100. 4. Create code demonstrations (if applicable)
  101. 5. Extract and include original code (if available)
  102. 6. Extract key figures and images
  103. 7. Update the global search index
  104. 8. Launch the web viewer automatically
  105. ### Launch Web Viewer
  106. ```bash
  107. # Claude Code
  108. /claude-paper:webui
  109. # OpenCode
  110. /claude-paper-webui
  111. ```
  112. In Codex or DeepSeek Harness, ask the agent to start the Claude Paper web viewer or explicitly load the `claude-paper-webui` Skill.
  113. Opens the interactive web interface at **http://localhost:5815** where you can:
  114. - Browse all studied papers
  115. - View generated materials with math rendering
  116. - Access code demonstrations and notebooks
  117. - Search through your paper library
  118. ---
  119. ## Paper Storage Structure
  120. Papers are organized in `~/claude-papers/papers/{paper-slug}/`:
  121. ```
  122. ~/claude-papers/
  123. β”œβ”€β”€ papers/
  124. β”‚ └── {paper-slug}/
  125. β”‚ β”œβ”€β”€ paper.pdf # Original PDF file
  126. β”‚ β”œβ”€β”€ paper.txt # Complete extracted text
  127. β”‚ β”œβ”€β”€ meta.json # Paper metadata (title, authors, etc.)
  128. β”‚ β”œβ”€β”€ quick-summary.md # Concise screening summary (quick workflow)
  129. β”‚ β”œβ”€β”€ README.md # Quick navigation and overview
  130. β”‚ β”œβ”€β”€ summary.md # Detailed summary
  131. β”‚ β”œβ”€β”€ insights.md # Key insights (most important!)
  132. β”‚ β”œβ”€β”€ method.md # Methodology (if complex)
  133. β”‚ β”œβ”€β”€ mental-model.md # Paper categorization (if needed)
  134. β”‚ β”œβ”€β”€ reflection.md # Future directions (if needed)
  135. β”‚ β”œβ”€β”€ qa.md # Learning questions
  136. β”‚ β”œβ”€β”€ index.html # Interactive HTML explorer
  137. β”‚ β”œβ”€β”€ images/ # Extracted figures and tables
  138. β”‚ β”‚ β”œβ”€β”€ fig1.png
  139. β”‚ β”‚ └── fig2.png
  140. β”‚ └── code/ # Code demonstrations
  141. β”‚ β”œβ”€β”€ core-demo.py # Clean reference implementation
  142. β”‚ └── concept-demo.ipynb # Interactive Jupyter notebook
  143. β”‚
  144. └── index.json # Global search index
  145. ```
  146. ---
  147. ## Architecture
  148. ### Plugin Structure
  149. ```
  150. claude-paper/
  151. β”œβ”€β”€ package.json # npm distribution manifest
  152. β”œβ”€β”€ bin/
  153. β”‚ └── claude-paper.mjs # npx install and upgrade entry point
  154. β”œβ”€β”€ .claude-plugin/
  155. β”‚ └── marketplace.json # Claude Code marketplace catalog
  156. β”œβ”€β”€ .codex-plugin/
  157. β”‚ └── plugin.json # Codex plugin manifest
  158. β”œβ”€β”€ .agents/skills/ # OpenCode and DSH discovery entries
  159. β”œβ”€β”€ .opencode/commands/ # OpenCode slash-command wrappers
  160. β”œβ”€β”€ skills/ # Codex packaged Skill adapters
  161. β”œβ”€β”€ scripts/
  162. β”‚ β”œβ”€β”€ sync-agent-adapters.mjs # Deterministic adapter generator
  163. β”‚ └── install-agent-adapters.mjs # Cross-agent installer and upgrader
  164. β”œβ”€β”€ plugin/
  165. β”‚ β”œβ”€β”€ .claude-plugin/
  166. β”‚ β”‚ └── plugin.json # Plugin manifest
  167. β”‚ β”œβ”€β”€ skills/
  168. β”‚ β”‚ β”œβ”€β”€ study/
  169. β”‚ β”‚ β”‚ β”œβ”€β”€ SKILL.md # Study workflow definition
  170. β”‚ β”‚ β”‚ └── scripts/
  171. β”‚ β”‚ β”‚ β”œβ”€β”€ parse-pdf.js # PDF parsing utility
  172. β”‚ β”‚ β”‚ └── extract-images.py # Image extraction
  173. β”‚ β”‚ β”œβ”€β”€ summary/
  174. β”‚ β”‚ β”‚ └── SKILL.md # Quick summary workflow definition
  175. β”‚ β”‚ └── webui/
  176. β”‚ β”‚ └── SKILL.md # Web viewer workflow definition
  177. β”‚ β”œβ”€β”€ commands/
  178. β”‚ β”‚ └── webui.md # /webui command
  179. β”‚ β”œβ”€β”€ hooks/
  180. β”‚ β”‚ β”œβ”€β”€ hooks.json # Session lifecycle hooks
  181. β”‚ β”‚ └── check-install.sh # Installation verification
  182. β”‚ β”œβ”€β”€ src/
  183. β”‚ β”‚ └── web/ # Nuxt.js web viewer
  184. β”‚ β”‚ β”œβ”€β”€ components/ # Vue components
  185. β”‚ β”‚ β”œβ”€β”€ composables/ # Vue composables
  186. β”‚ β”‚ β”œβ”€β”€ server/ # API endpoints
  187. β”‚ β”‚ └── package.json
  188. β”‚ └── package.json
  189. └── README.md
  190. ```
  191. ### Key Components
  192. 1. **Study Skill** - Main workflow agent that orchestrates deep paper processing
  193. 2. **Summary Skill** - Concise paper-screening workflow
  194. 3. **PDF Parser** - Extracts text, metadata, and code links using pdf-parse
  195. 4. **Image Extractor** - Python script for PDF figure extraction
  196. 5. **Web Viewer** - Nuxt.js application with Nitro API server
  197. 6. **Hooks System** - Claude Code lifecycle setup
  198. 7. **Agent Adapters** - Generated discovery and invocation wrappers for Codex, OpenCode, and DeepSeek Harness
  199. ---
  200. ## Development
  201. ### Running Tests
  202. ```bash
  203. # Verify cross-agent adapters and reviewed canonical Claude Skills
  204. npm test
  205. # Verify generated adapters are synchronized
  206. npm run check:adapters
  207. # Test PDF parsing
  208. node plugin/skills/study/scripts/parse-pdf.js /path/to/paper.pdf
  209. # Test web viewer
  210. cd plugin/src/web
  211. npm run dev
  212. # Test full workflow
  213. cd /path/to/claude-paper
  214. claude --plugin-dir ./plugin
  215. /claude-paper:study /path/to/paper.pdf
  216. ```
  217. ### Verifying the npm Distribution
  218. ```bash
  219. # Runs adapter checks and tests before producing the publishable tarball
  220. npm pack --dry-run
  221. ```
  222. ### Building for Production
  223. ```bash
  224. # Build web viewer
  225. cd plugin/src/web
  226. npm run build
  227. # The built viewer will be in .output/
  228. ```
  229. ---
  230. ## Configuration
  231. ### Environment Variables
  232. No configuration required! The plugin uses sensible defaults:
  233. - **Papers directory**: `~/claude-papers/`
  234. - **Web viewer port**: `5815`
  235. - **Metadata preview limit**: `50,000` characters; complete extracted text remains in `paper.txt`
  236. ### Advanced Customization
  237. You can modify behavior by editing the skill file at:
  238. `plugin/skills/study/SKILL.md`
  239. ---
  240. ## Contributing
  241. Contributions are welcome! Please:
  242. 1. Fork the repository
  243. 2. Create a feature branch (`git checkout -b feature/amazing-feature`)
  244. 3. Make your changes
  245. 4. Add tests if applicable
  246. 5. Commit your changes (`git commit -m 'add amazing feature'`)
  247. 6. Push to the branch (`git push origin feature/amazing-feature`)
  248. 7. Open a Pull Request
  249. ---
  250. ## License
  251. This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
  252. ---
  253. ## Acknowledgments
  254. - Built with [Claude Code](https://code.claude.com)
  255. - PDF parsing powered by [pdf-parse](https://github.com/ffalt/json2csv-converter)
  256. - Web viewer built with [Nuxt.js](https://nuxt.com)
  257. - Math rendering by [KaTeX](https://katex.org)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.