Skip to main content

Scientific paper search and ranking across OpenAlex, Semantic Scholar, and Unpaywall

Project description

paper-search

Search and rank scientific papers and GitHub repositories from the command line.

Queries OpenAlex (250M+ works), Semantic Scholar (215M+ papers), and Unpaywall in parallel, merges results by DOI, and outputs ranked papers with citation counts, TLDRs, and PDF links. Search GitHub for related code repositories. Export as BibTeX or JSON, save to .claude/papers.md for project context, or open PDFs directly in the browser.

Installation

uv tool install paper-search

Or from source:

git clone https://github.com/Csed-dev/paper-search.git
cd paper-search
uv sync

Quick Start

# Search papers by topic, ranked by citations
paper-search papers "large language models" -n 10

# Filter by year or year range
paper-search papers "vision transformers" --year 2022-2024 --sort date

# Find similar papers (accepts DOI, arXiv ID, or Semantic Scholar ID)
paper-search recommend 1706.03762 -n 10

# Search GitHub repositories
paper-search repos "transformer attention" --language python --min-stars 100

# Export as BibTeX
paper-search papers "reinforcement learning" -n 5 --bibtex -o refs.bib

# Export as JSON for scripting
paper-search papers "graph neural networks" --json | jq '.[].title'

# Save results to .claude/papers.md in current project
paper-search papers "federated learning" --save

# Open a paper's PDF in the browser
paper-search open 1706.03762

Example Output

$ paper-search papers "attention mechanism" -n 3

  Results for: attention mechanism
  3 papers, sorted by citations

    1. Faster R-CNN: Towards Real-Time Object Detection with Region Proposal Networks (2016) [52848 citations] (9606 influential) [OA]
       Shaoqing Ren, Kaiming He, Ross Girshick, Jian Sun
       DOI: 10.1109/tpami.2016.2577031
       PDF: https://arxiv.org/pdf/1506.01497

    2. Effective Approaches to Attention-based Neural Machine Translation (2015) [8517 citations] [OA]
       Thang Luong, Hieu Pham, Christopher D. Manning
       DOI: 10.18653/v1/d15-1166

    3. Attention mechanisms in computer vision: A survey (2022) [2242 citations] [OA]
       Meng-Hao Guo, Tian-Xing Xu, Jiangjiang Liu, Zheng-Ning Liu, Peng-Tao Jiang +5 more
       DOI: 10.1007/s41095-022-0271-y
       PDF: https://arxiv.org/pdf/2111.07624

What It Does

paper-search papers "query"
        |
        +--- OpenAlex ---------- phrase search, topic taxonomy, citation ranking
        |
        +--- Semantic Scholar -- TLDR summaries, influential citations, BibTeX
        |
        +--- Unpaywall --------- OA PDF links (when --email is set)
        |
        v
    Merge by DOI -> Rank -> Display / Save / Export

Commands

papers (alias: p)

paper-search papers "query" [options]
Flag Description
-n, --limit N Number of results (default: 10)
-y, --year YEAR Publication year or range (e.g. 2024, 2022-2024)
--sort citations|date|relevance Sort order (default: citations)
--save Append results to .claude/papers.md
--bibtex Output BibTeX format
--json Output JSON format
-o FILE Write output to file (e.g. -o refs.bib)
--email EMAIL Enable Unpaywall PDF links + faster OpenAlex
--s2-key KEY Semantic Scholar API key

repos

paper-search repos "query" [options]
Flag Description
-n, --limit N Number of results (default: 10)
--sort stars|forks|updated Sort order (default: stars)
--language LANG Filter by programming language (e.g. python)
--min-stars N Minimum star count
--json Output JSON format
-o FILE Write output to file

Uses GITHUB_TOKEN env var if available (30 req/min vs 10 req/min without).

recommend (alias: r)

paper-search recommend <paper_id> [options]

Accepts DOI (10.1038/s41586-023-06291-2), arXiv ID (1706.03762, hep-th/9905111), or Semantic Scholar ID.

Same flags as papers: --save, --bibtex, --json, -o, --email, --s2-key, -n.

open

paper-search open <paper_id>

Opens the paper's PDF (or DOI landing page) in the default browser.

Configuration

Environment Variables

Variable Description
PAPER_SEARCH_EMAIL Email for OpenAlex polite pool + Unpaywall
PAPER_SEARCH_S2_KEY Semantic Scholar API key
GITHUB_TOKEN GitHub token for higher rate limits

Config File

Create ~/.config/paper-search/config.toml to avoid passing flags every time:

email = "you@example.com"
s2_key = "your-semantic-scholar-api-key"
github_token = "ghp_..."

Priority: CLI flags > environment variables > config file.

The --save Flag

When used inside a project directory, --save writes results to .claude/papers.md. This file persists as context for Claude Code, making your paper references available in future conversations.

cd my-research-project
paper-search papers "federated learning" -n 15 --save
# Creates .claude/papers.md with formatted paper references

Running the same query twice with --save won't duplicate the section.

API Keys (Free)

All APIs work without keys, just with lower rate limits:

Development

git clone https://github.com/Csed-dev/paper-search.git
cd paper-search
uv sync --group dev
uv run pytest

Tests use captured API fixtures (no network calls):

uv run pytest tests/ -v    # 84 tests, runs in <1s

To refresh fixtures from live APIs:

uv run python tests/capture_fixtures.py

Contributing

See CONTRIBUTING.md for guidelines.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

paper_search-0.3.0.tar.gz (496.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

paper_search-0.3.0-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

Details for the file paper_search-0.3.0.tar.gz.

File metadata

  • Download URL: paper_search-0.3.0.tar.gz
  • Upload date:
  • Size: 496.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for paper_search-0.3.0.tar.gz
Algorithm Hash digest
SHA256 12b4d19a7f31af55459f3dc65c7fb59c53cd0c6d31f1bc02eb7b4613929ee154
MD5 899af484a373acd081ba4890c4cff5fe
BLAKE2b-256 2ca0e65ed2ff321f657f84f1756857b8bb52898c4c6e34f84acd8b2183d447f5

See more details on using hashes here.

Provenance

The following attestation bundles were made for paper_search-0.3.0.tar.gz:

Publisher: release.yml on Csed-dev/paper-search

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file paper_search-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: paper_search-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 17.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for paper_search-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 52e68fcc9feeebfef12d0e0b50e2e20d212c4455e478202ef2f94ab207ae16c2
MD5 a8f037b75f6342762ce0ad387356f4b3
BLAKE2b-256 f810e98cdf6ae515f2dd70cf2548395c18bf604b3af8e99a480ff699b13d9698

See more details on using hashes here.

Provenance

The following attestation bundles were made for paper_search-0.3.0-py3-none-any.whl:

Publisher: release.yml on Csed-dev/paper-search

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page