Skip to main content

A CLI research agent for AI-related paper search, code discovery, PDF collection, and bilingual reports.

Project description

PaperPilot

A CLI AI literature search agent that follows a Planner + Tool Pipeline + Reflection + Report Writer architecture.

Quick Start

pip install -e .
PaperPilot

Command mode:

PaperPilot "LLM agent" --auto-confirm --max-papers 30 --since-year 2021

LLM Config

Recommended:

PaperPilot config set --base-url https://api.deepseek.com --model deepseek-chat
PaperPilot config show

The config is stored at ~/.paperpilot/config.json with file mode 600 where supported.

Priority:

  1. Environment variables: OPENAI_API_KEY, OPENAI_BASE_URL, OPENAI_MODEL
  2. User config: ~/.paperpilot/config.json
  3. Legacy project file: llmapi.txt

Without an LLM key, the CLI still runs with deterministic fallback query planning and templated reports.

Outputs

Each run writes:

  • task.json
  • query_understanding.md
  • plan.json
  • metadata.json
  • ranked_papers.json
  • reflection.json
  • report.zh.md
  • report.en.md
  • report.zh.pdf
  • report.en.pdf
  • download_log.json
  • pdfs/

GitHub Filter

literature-agent "retrieval augmented generation" --auto-confirm --github-filter required
  • any: keep all papers and annotate code availability.
  • required: keep papers with a detected public code link.
  • none: keep papers without detected public code links.

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

paperpilot-0.2.0.tar.gz (26.0 kB view details)

Uploaded Source

Built Distribution

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

paperpilot-0.2.0-py3-none-any.whl (29.7 kB view details)

Uploaded Python 3

File details

Details for the file paperpilot-0.2.0.tar.gz.

File metadata

  • Download URL: paperpilot-0.2.0.tar.gz
  • Upload date:
  • Size: 26.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for paperpilot-0.2.0.tar.gz
Algorithm Hash digest
SHA256 52738558be6558ec086b8eb8ed99e289718cd573960e45bf1623a02de6130b07
MD5 de84510c296b24abe1f1612342a0f3dc
BLAKE2b-256 6cb15bdb28799fb8dc376432245d99aea8498e15059972124c5eade480bd04a0

See more details on using hashes here.

File details

Details for the file paperpilot-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: paperpilot-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 29.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for paperpilot-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2435945f179a8f523ff7ab7765251e30d637d3ceb9bacb6f7be796c73bae6e98
MD5 a5adf4f9f5cb78fb5a03254c78185f20
BLAKE2b-256 9fd3aeaae97c4674c1b683eae60d5e692e46176e263a91ad8ce77e1787be2898

See more details on using hashes here.

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