npm package: @paperscope/cli
Description: PaperScope CLI - Search and explore academic papers from your terminal
Author: PaperScope Team
Latest version: 1.2.1

# PaperScope CLI

Search and explore academic papers from your terminal. Powered by [PaperScope](https://www.paperscope.ai).

## Features

- Search 55,000+ academic papers (arXiv, HuggingFace, top conferences)
- Read AI-generated blogs, summaries, and tags
- Take quizzes to test your understanding
- Browse trending papers and conference proceedings
- Beautiful terminal output with colors and formatting

## Installation

### From source (requires [Bun](https://bun.sh))

```bash
git clone https://github.com/paperscope/paperscope-cli.git
cd paperscope-cli
bun install
bun run build
```

The compiled binary will be at `dist/paperscope`. Add it to your PATH:

```bash
sudo ln -s $(pwd)/dist/paperscope /usr/local/bin/paperscope
```

### Development mode

```bash
bun run dev -- search "transformer"
```

## Configuration

### API Key (optional)

An API key gives you higher rate limits. Get one at [paperscope.ai](https://www.paperscope.ai).

```bash
# Save API key
paperscope config set-key psk_your_api_key_here

# Or use environment variable
export PAPERSCOPE_API_KEY=psk_your_api_key_here

# View config
paperscope config show

# Remove saved key
paperscope config clear-key
```

> **Security note:** The API key is stored in plaintext at `~/.paperscope/config.json` with `0600` permissions (owner-only read/write). On shared or multi-user machines, prefer the `PAPERSCOPE_API_KEY` environment variable instead.

## Usage

### Search papers

```bash
# Basic search
paperscope search "transformer attention"

# Limit results
paperscope search "LLM reasoning" --limit 5

# Filter by tags
paperscope search "multimodal" --tags Agent

# Filter by source
paperscope search "diffusion" --source hf
```

### Read paper details

```bash
# Show paper info (abstract, authors, tags)
paperscope read 2501.12345

# Read AI-generated blog post
paperscope read 2501.12345 --blog

# Read AI-generated summary
paperscope read 2501.12345 --summary

# Show paper tags with descriptions
paperscope read 2501.12345 --tags
```

### Take a quiz

```bash
paperscope quiz 2501.12345
```

### Trending papers

```bash
# Default: top 10
paperscope trending

# Custom limit
paperscope trending --limit 20

# By period
paperscope trending --period weekly
```

### Conference papers

```bash
# CVPR 2025
paperscope conf cvpr2025

# ACL 2025 with limit
paperscope conf acl2025 --limit 20

# NeurIPS
paperscope conf neurips2024 --limit 10
```

## Available Tags

LLM, Reasoning, Agent, Multimodal, RAG, Image-Generation, Video-Generation, 3D-Generation, Audio-Speech, Robot, Autonomous-Driving, Reinforcement-Learning, AI-Infrastructure, Data-Centric, Coding, Medical-Bio, AI-For-Science, AI-Safety, World-Model, Benchmark

## API

PaperScope CLI uses the [PaperScope Public API](https://api.paperscope.ai/v1).

| Endpoint | Description |
|----------|-------------|
| `GET /v1/papers/search` | Search papers |
| `GET /v1/papers/{id}` | Paper details |
| `GET /v1/papers/{id}/blog` | AI blog post |
| `GET /v1/papers/{id}/summary` | AI summary |
| `GET /v1/papers/{id}/tags` | Paper tags |
| `GET /v1/papers/{id}/quiz` | Quiz |
| `GET /v1/papers/trending` | Trending papers |
| `GET /v1/papers/conference/{name}` | Conference papers |

## Tech Stack

- TypeScript + [Bun](https://bun.sh)
- [Commander.js](https://github.com/tj/commander.js) - CLI framework
- [Chalk](https://github.com/chalk/chalk) - Terminal colors
- [Ora](https://github.com/sindresorhus/ora) - Loading spinners

## License

MIT

---

# PaperScope CLI (中文)

在终端搜索和浏览学术论文。基于 [PaperScope](https://www.paperscope.ai)。

## 功能

- 搜索 55,000+ 篇学术论文 (arXiv、HuggingFace、顶会)
- 阅读 AI 生成的博客解读、摘要和标签
- 做 Quiz 测验, 检验论文理解
- 浏览热门论文和顶会论文
- 终端彩色美观输出

## 安装

```bash
git clone https://github.com/paperscope/paperscope-cli.git
cd paperscope-cli
bun install
bun run build
sudo ln -s $(pwd)/dist/paperscope /usr/local/bin/paperscope
```

## 使用

```bash
# 搜索论文
paperscope search "大模型推理"

# 查看论文详情
paperscope read 2501.12345

# 阅读 AI 博客解读
paperscope read 2501.12345 --blog

# 阅读 AI 摘要
paperscope read 2501.12345 --summary

# 查看标签
paperscope read 2501.12345 --tags

# 做测验
paperscope quiz 2501.12345

# 热门论文
paperscope trending --limit 10

# 顶会论文
paperscope conf cvpr2025 --limit 20

# 配置 API Key (可选, 提高限额)
paperscope config set-key psk_your_api_key
```