paper-search-cli 0.1.3 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.env.example +14 -5
- package/README.md +151 -617
- package/README.zh.md +268 -0
- package/dist/cli.js +199 -21
- package/dist/cli.js.map +1 -1
- package/dist/config/ConfigService.d.ts +1 -1
- package/dist/config/ConfigService.d.ts.map +1 -1
- package/dist/config/ConfigService.js +2 -2
- package/dist/config/ConfigService.js.map +1 -1
- package/dist/config/ResultCaps.d.ts +4 -0
- package/dist/config/ResultCaps.d.ts.map +1 -0
- package/dist/config/ResultCaps.js +10 -0
- package/dist/config/ResultCaps.js.map +1 -0
- package/dist/core/capabilityProfile.d.ts +18 -0
- package/dist/core/capabilityProfile.d.ts.map +1 -0
- package/dist/core/capabilityProfile.js +153 -0
- package/dist/core/capabilityProfile.js.map +1 -0
- package/dist/core/diagnostics.d.ts.map +1 -1
- package/dist/core/diagnostics.js +35 -15
- package/dist/core/diagnostics.js.map +1 -1
- package/dist/core/handleToolCall.d.ts.map +1 -1
- package/dist/core/handleToolCall.js +27 -0
- package/dist/core/handleToolCall.js.map +1 -1
- package/dist/core/liveSmoke.d.ts +42 -0
- package/dist/core/liveSmoke.d.ts.map +1 -0
- package/dist/core/liveSmoke.js +226 -0
- package/dist/core/liveSmoke.js.map +1 -0
- package/dist/core/platformMetadata.js +2 -2
- package/dist/core/platformMetadata.js.map +1 -1
- package/dist/core/schemas.d.ts +77 -2
- package/dist/core/schemas.d.ts.map +1 -1
- package/dist/core/schemas.js +57 -3
- package/dist/core/schemas.js.map +1 -1
- package/dist/core/textReports.d.ts +21 -0
- package/dist/core/textReports.d.ts.map +1 -0
- package/dist/core/textReports.js +85 -0
- package/dist/core/textReports.js.map +1 -0
- package/dist/core/tools.d.ts.map +1 -1
- package/dist/core/tools.js +31 -1
- package/dist/core/tools.js.map +1 -1
- package/dist/platforms/CORESearcher.d.ts.map +1 -1
- package/dist/platforms/CORESearcher.js +39 -9
- package/dist/platforms/CORESearcher.js.map +1 -1
- package/dist/platforms/OpenAIRESearcher.js +1 -1
- package/dist/platforms/OpenAIRESearcher.js.map +1 -1
- package/dist/services/JournalMetricsService.d.ts +38 -0
- package/dist/services/JournalMetricsService.d.ts.map +1 -0
- package/dist/services/JournalMetricsService.js +142 -0
- package/dist/services/JournalMetricsService.js.map +1 -0
- package/dist/skills/SkillInstaller.d.ts +108 -0
- package/dist/skills/SkillInstaller.d.ts.map +1 -0
- package/dist/skills/SkillInstaller.js +389 -0
- package/dist/skills/SkillInstaller.js.map +1 -0
- package/package.json +2 -2
- package/skills/paper-search/SKILL.md +53 -127
- package/skills/paper-search/references/capability-routing.md +134 -0
- package/skills/paper-search/references/cli-contract.md +133 -0
- package/skills/paper-search/references/management-layer.md +139 -0
- package/README-sc.md +0 -734
package/.env.example
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
# ==============================================================================
|
|
2
2
|
# Paper Search CLI - Environment Variables
|
|
3
3
|
# ==============================================================================
|
|
4
|
-
# Supports 25 academic sources/platforms with a unified CLI interface
|
|
4
|
+
# Supports 25 academic sources/platforms with a unified CLI interface,
|
|
5
|
+
# plus EasyScholar journal metrics lookup
|
|
5
6
|
# Platforms: Crossref, OpenAlex, PubMed, PubMed Central, Europe PMC, arXiv,
|
|
6
7
|
# bioRxiv, medRxiv, Semantic Scholar, CORE, OpenAIRE, Web of Science,
|
|
7
8
|
# Google Scholar, DBLP, ACM metadata, USENIX metadata, OpenReview,
|
|
@@ -59,6 +60,15 @@ NCBI_TOOL=paper-search-cli
|
|
|
59
60
|
# Pricing: Free for academic use
|
|
60
61
|
SEMANTIC_SCHOLAR_API_KEY=your_semantic_scholar_api_key_here
|
|
61
62
|
|
|
63
|
+
# ------------------------------------------------------------------------------
|
|
64
|
+
# EasyScholar Journal Metrics API - REQUIRED for journal metrics
|
|
65
|
+
# ------------------------------------------------------------------------------
|
|
66
|
+
# Query journal-level metrics such as impact factor, JCR quartile, CAS zones,
|
|
67
|
+
# JCI, ESI, warning flags, and selected rank datasets.
|
|
68
|
+
# Configure through `paper-search setup EASYSCHOLAR_KEY` when possible so the
|
|
69
|
+
# SecretKey is entered through a hidden prompt instead of appearing in shell history.
|
|
70
|
+
EASYSCHOLAR_KEY=your_easyscholar_secret_key_here
|
|
71
|
+
|
|
62
72
|
# ------------------------------------------------------------------------------
|
|
63
73
|
# Unpaywall - REQUIRED for DOI-based open-access resolution
|
|
64
74
|
# ------------------------------------------------------------------------------
|
|
@@ -76,17 +86,15 @@ UNPAYWALL_EMAIL=you@example.com
|
|
|
76
86
|
# Anonymous access can be heavily rate-limited
|
|
77
87
|
# Get API key: https://core.ac.uk/services/api
|
|
78
88
|
# Pricing: Free tier available
|
|
79
|
-
PAPER_SEARCH_CORE_API_KEY=your_core_api_key_here
|
|
80
|
-
# Legacy-compatible fallback name
|
|
81
89
|
CORE_API_KEY=your_core_api_key_here
|
|
90
|
+
# CORE per-command result cap; default 100, hard maximum 500
|
|
91
|
+
CORE_MAX_RESULTS_CAP=100
|
|
82
92
|
|
|
83
93
|
# ------------------------------------------------------------------------------
|
|
84
94
|
# OpenAIRE - OPTIONAL
|
|
85
95
|
# ------------------------------------------------------------------------------
|
|
86
96
|
# Open repository discovery source; public search usually works without a key
|
|
87
97
|
# API docs: https://develop.openaire.eu/
|
|
88
|
-
PAPER_SEARCH_OPENAIRE_API_KEY=your_openaire_api_key_here
|
|
89
|
-
# Legacy-compatible fallback name
|
|
90
98
|
OPENAIRE_API_KEY=your_openaire_api_key_here
|
|
91
99
|
|
|
92
100
|
# ------------------------------------------------------------------------------
|
|
@@ -148,6 +156,7 @@ WILEY_TDM_TOKEN=your_wiley_tdm_token_here
|
|
|
148
156
|
# bioRxiv | ✅ Free | Biology preprints, PDF | Biology research
|
|
149
157
|
# medRxiv | ✅ Free | Medical preprints, PDF | Medical research
|
|
150
158
|
# Semantic Scholar | 🟡 Optional| AI-powered search, citations | CS, AI research
|
|
159
|
+
# EasyScholar | 🔴 Required| IF, JCR/CAS zones, JCI, ESI | Journal metrics
|
|
151
160
|
# CORE | 🟡 Optional| Repository PDFs | Open repositories
|
|
152
161
|
# OpenAIRE | 🟡 Optional| Repository discovery | Open repositories
|
|
153
162
|
# DBLP | ✅ Free | CS bibliography metadata | CS literature
|