You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
v0.3.8: README clarify optional keys, fix S2 API key URL
- Both SEMANTIC_SCHOLAR_API_KEY and GOOGLE_BOOKS_API_KEY are clearly
marked as optional; tool works without them (anonymous rate limits apply)
- Fix Semantic Scholar API key URL to semanticscholar.org/product/api#api-key
- Improve env var table to show *(optional)* instead of bare dash
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+13-11Lines changed: 13 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -214,27 +214,29 @@ asyncio.run(main())
214
214
215
215
## Environment variables
216
216
217
+
All API keys are **optional** — CiteSentry works without any keys but will hit anonymous rate limits faster when checking large reference lists.
218
+
217
219
| Variable | Default | Description |
218
220
|---|---|---|
219
221
|`CITESENTRY_MAILTO`|`citesentry@example.com`| Polite email for OpenAlex/Crossref API (strongly recommended) |
220
-
|`SEMANTIC_SCHOLAR_API_KEY`|—|Free key from [semanticscholar.org/product/api](https://www.semanticscholar.org/product/api) — raises rate limit from ~1 req/s to 100 req/5s |
221
-
|`GOOGLE_BOOKS_API_KEY`|—|Free key from [Google Cloud Console](https://console.cloud.google.com) — raises limit from ~1k/day to 100k/day; used for textbook lookup |
222
-
|`CITESENTRY_GROBID_URL`|`https://kermitt2-grobid.hf.space/api`| GROBID REST endpoint for high-quality PDF parsing; use `http://localhost:8070/api` for a local Docker instance |
223
-
|`DEEPSEEK_API_KEY`|—|Required for relevance checks in CLI (`--no-llm`skips this)|
222
+
|`SEMANTIC_SCHOLAR_API_KEY`|*(optional)*|Raises Semantic Scholar rate limit from ~1 req/s to 100 req/5s — see below|
223
+
|`GOOGLE_BOOKS_API_KEY`|*(optional)*|Raises Google Books limit from ~1k req/day to 100k/day; used for textbook lookup |
224
+
|`CITESENTRY_GROBID_URL`|*(optional)*| GROBID REST endpoint for high-quality PDF parsing; use `http://localhost:8070/api` for a local Docker instance |
225
+
|`DEEPSEEK_API_KEY`|*(optional)*|Enables relevance checks in CLI; without it `--no-llm`is effectively applied|
0 commit comments