Zotero — Printing Press CLI
Prerequisites: Install the CLI
This skill drives the zotero-research-library-pp-cli binary. You must verify the CLI is installed before invoking any command from this skill. If it is missing, install it first:
- Install via the Printing Press installer. It defaults binaries to
$HOME/.local/binon macOS/Linux and%LOCALAPPDATA%\Programs\PrintingPress\binon Windows:npx -y @mvanhorn/printing-press-library install zotero-research-library --cli-only - Verify:
zotero-research-library-pp-cli --version - Ensure the reported install directory is on
$PATHfor the agent/runtime that will invoke this skill.
If the npx install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.5 or newer). This installs into $GOPATH/bin (default $HOME/go/bin), so add that directory to $PATH instead:
go install github.com/mvanhorn/printing-press-library/library/productivity/zotero-research-library/cmd/zotero-research-library-pp-cli@latest
If --version reports "command not found" after install, the runtime cannot see the binary directory on $PATH. Do not proceed with skill commands until verification succeeds.
zotero-research-library-pp-cli mirrors your library into a local SQLite cache using the API's version cursors, then answers research-grounding questions offline: ranked full-text search with snippets, collection trees, recent-additions triage, and Better BibTeX citekey lookups. What the Web API meters at 100 items a page, your cache answers in milliseconds.
When to Use This CLI
Use this CLI whenever a task needs the user's own research library: grounding answers in their curated corpus, finding citations, browsing collections, or exporting BibTeX. It is the substrate for research-grounding workflows — search the local cache first, fall back to live API or open web only when the cache misses.
Anti-triggers
Do not use this CLI for:
- Do not use this CLI to create, modify, or delete items in Zotero — it is read-only against the API
- Do not use it for PDF download or attachment file retrieval; it indexes extracted text only
- Do not use it for open-web literature search — it covers the user's own library
Unique Capabilities
These capabilities aren't available in any other tool for this API.
Research grounding that compounds
ground— Ranked full-text search over your synced library — title, abstract, creators, tags, and attachment full text — answered offline in under a second, with snippets and citation-ready metadata.Reach for this when asked what the user's own library says about a topic.
zotero-research-library-pp-cli ground "hamstring injury prevention" --limit 10 --agentitems recent— What landed in the library recently, sorted by dateAdded from the local cache, with a --days cutoff and pipeable keys.Use for weekly triage of new additions.
zotero-research-library-pp-cli items recent --days 7 --agentcollections tree— Renders the full collection hierarchy with per-node item counts in one command — a shape the flat API cannot return in one call.Use for a hierarchical overview of how the library is organized.
zotero-research-library-pp-cli collections tree --counts --agent
Manuscript plumbing
cite— Resolves a Better BibTeX citekey to its item from the local cache and exports citekey-faithful BibTeX; sync backfills citekeys via the desktop's local JSON-RPC when available.Use when a manuscript needs a citation by its Better BibTeX citekey.
zotero-research-library-pp-cli cite smithHamstring2024 --format bibtex
Agent-native plumbing
cache status— Sync cursors, row and FTS counts, and last-sync age from the local cache; 'cache reindex' rebuilds the FTS index from base tables with zero network.Use to check cache freshness offline before trusting search results.
zotero-research-library-pp-cli cache status --agent
Command Reference
collections — Hierarchical collections organizing the library
zotero-research-library-pp-cli collections get— One collection by keyzotero-research-library-pp-cli collections items— Items in a collection (including children)zotero-research-library-pp-cli collections list— All collectionszotero-research-library-pp-cli collections subcollections— Subcollections of a collectionzotero-research-library-pp-cli collections top— Top-level collections
deleted — Deletion tombstones for sync
zotero-research-library-pp-cli deleted— Keys of items/collections/searches/tags deleted since a library version
fulltext — Full-text content index
zotero-research-library-pp-cli fulltext— Attachment keys whose full-text content changed since a version
items — Bibliographic items in the library
zotero-research-library-pp-cli items children— Child notes and attachments of an itemzotero-research-library-pp-cli items fulltext— Full-text content of an attachment itemzotero-research-library-pp-cli items get— Get one item by keyzotero-research-library-pp-cli items list— List items.zotero-research-library-pp-cli items top— Top-level items only (no child notes/attachments)zotero-research-library-pp-cli items trash— Items in the trash
keys — API key introspection
zotero-research-library-pp-cli keys— Resolve the current API key to userID, username, and access scopes (doctor probe + userID discovery)
searches — Saved searches
zotero-research-library-pp-cli searches get— One saved searchzotero-research-library-pp-cli searches list— All saved searches
tags — Tags across the library
zotero-research-library-pp-cli tags— All tags in the library
Freshness Contract
This printed CLI owns bounded freshness only for registered store-backed read command paths. In --data-source auto mode, those paths check sync_state and may run a bounded refresh before reading local data. --data-source local never refreshes. --data-source live reads the API and does not mutate the local store. Set ZOTERO_RESEARCH_LIBRARY_NO_AUTO_REFRESH=1 to skip the freshness hook without changing source selection.
Covered paths:
zotero-research-library-pp-cli collectionszotero-research-library-pp-cli collections getzotero-research-library-pp-cli collections listzotero-research-library-pp-cli collections searchzotero-research-library-pp-cli deletedzotero-research-library-pp-cli deleted getzotero-research-library-pp-cli deleted listzotero-research-library-pp-cli deleted searchzotero-research-library-pp-cli itemszotero-research-library-pp-cli items getzotero-research-library-pp-cli items listzotero-research-library-pp-cli items searchzotero-research-library-pp-cli searcheszotero-research-library-pp-cli searches getzotero-research-library-pp-cli searches listzotero-research-library-pp-cli searches searchzotero-research-library-pp-cli tagszotero-research-library-pp-cli tags getzotero-research-library-pp-cli tags listzotero-research-library-pp-cli tags search
When JSON output uses the generated provenance envelope, freshness metadata appears at meta.freshness. Treat it as current-cache freshness for the covered command path, not a guarantee of complete historical backfill or API-specific enrichment.
Finding the right command
When you know what you want to do but not which command does it, ask the CLI directly:
zotero-research-library-pp-cli which "<capability in your own words>"
which resolves a natural-language capability query to the best matching command from this CLI's curated feature index. Exit code 0 means at least one match; exit code 2 means no confident match — fall back to --help or use a narrower query.
Recipes
Research-grounding query
zotero-research-library-pp-cli ground "return to play criteria" --limit 10 --agent --select key,title,creators,date,DOI
Offline ranked search with citation-ready fields; the first step of the grounding workflow.
Full-text deep search
zotero-research-library-pp-cli ground "nordic hamstring" --fulltext --agent
Extends the search into attachment full text and resolves hits to their parent papers.
Weekly additions to BibTeX
zotero-research-library-pp-cli items recent --days 7 --agent --select key,title
Fresh additions ready to pipe into an export.
Scope a search to a collection
zotero-research-library-pp-cli ground "acl injury" --collection HAMSTRING --limit 5
Collection-scoped grounding using the local join table.
Live server-side search fallback
zotero-research-library-pp-cli items list --q "tendon" --qmode everything --limit 10 --json
When you need unsynced server state, the generated endpoint carries the API's full search grammar.
Auth Setup
Create an API key at zotero.org/settings/keys and set ZOTERO_API_KEY (or run auth set-token). The CLI resolves your numeric userID automatically via /keys/current and stores the library-prefixed base URL in config — you never need to look up your user ID.
Run zotero-research-library-pp-cli doctor to verify setup.
Agent Mode
Add --agent to any command. Expands to: --json --compact --no-input --no-color --yes.
Pipeable — JSON on stdout, errors on stderr
Filterable —
--selectkeeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs:zotero-research-library-pp-cli collections list --agent --select id,name,statusPreviewable —
--dry-runshows the request without sendingOffline-friendly — sync/search commands can use the local SQLite store when available
Non-interactive — never prompts, every input is a flag
Read-only — do not use this CLI for create, update, delete, publish, comment, upvote, invite, order, send, or other mutating requests
Response envelope
Commands that read from the local store or the API wrap output in a provenance envelope:
{
"meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
"results": <data>
}
Parse .results for data and .meta.source to know whether it's live or local. A human-readable N results (live) summary is printed to stderr only when stdout is a terminal AND no machine-format flag (--json, --csv, --compact, --quiet, --plain, --select) is set — piped/agent consumers and explicit-format runs get pure JSON on stdout.
Paths and state
Agents should treat the CLI's path resolver as part of the runtime contract:
Use
--home <dir>for one invocation, or setZOTERO_RESEARCH_LIBRARY_HOME=<dir>to relocate all four path kinds under one root.Use per-kind env vars only when a specific kind must diverge:
ZOTERO_RESEARCH_LIBRARY_CONFIG_DIR,ZOTERO_RESEARCH_LIBRARY_DATA_DIR,ZOTERO_RESEARCH_LIBRARY_STATE_DIR,ZOTERO_RESEARCH_LIBRARY_CACHE_DIR.Resolution order is per-kind env var,
--home,ZOTERO_RESEARCH_LIBRARY_HOME, XDG (XDG_CONFIG_HOME,XDG_DATA_HOME,XDG_STATE_HOME,XDG_CACHE_HOME), then platform defaults.configcontains settings likeconfig.tomland profiles.datacontainscredentials.toml,data.db, cookies, and auth sidecars.statecontains persisted queries, jobs, andteach.log.cachecontains regenerable HTTP/cache files.Stored secrets live in
credentials.tomlunder the data dir. Existing legacyconfig.tomlsecrets are read for compatibility and leaveconfig.tomlon the first auth write.Run
zotero-research-library-pp-cli doctor --fail-on warnto surface path and credential-location warnings.agent-contextexposes a schema v4pathsblock for agents that need the resolved dirs.For MCP, pass relocation through the MCP host config. The MCP binary does not inherit CLI flags:
{ "mcpServers": { "zotero-research-library": { "command": "zotero-research-library-pp-mcp", "env": { "ZOTERO_RESEARCH_LIBRARY_HOME": "/srv/zotero-research-library" } } } }
Fleet precedence: an inherited per-kind env var overrides an explicit --home for that kind. Use ZOTERO_RESEARCH_LIBRARY_HOME or per-kind vars as durable fleet levers, and use --home only for a single invocation. Relocation is not reversible by unsetting env vars; move files manually before clearing ZOTERO_RESEARCH_LIBRARY_HOME, or doctor will not find credentials left under the former root.
Automatic learning
This CLI ships a self-capturing learning loop. The CLI does its own bookkeeping: every invocation is journaled locally, a failed flag followed by a corrected retry auto-derives a flag_alias candidate, and a teach on a query family without a playbook auto-synthesizes a playbook_candidate from the session's journal. Your job is judgment only: recall first, act on surfaced candidates, teach the final answer, playbook amend when you observe a correction. You never record failures by hand.
Step 1: recall before any discovery
Before list/search/drill commands on a new user question, run:
zotero-research-library-pp-cli recall "<user's question>" --agent
The response envelope:
{
"query": "...",
"normalized": "<normalized form>",
"query_entities": ["..."],
"found": true | false,
"match_score": 0.0,
"results": [
{ "resource_id": "...", "resource_type": "...", "venue": "...",
"confidence": 2, "entity_match": "exact|partial|unknown",
"source": "taught|preseed|pattern", "warnings": ["..."] }
],
"mismatches": [ /* only when --debug-mismatches */ ],
"warnings": [ /* top-level */ ],
"candidates": [
{ "id": 12, "class": "flag_alias | playbook_candidate",
"summary": "...", "sightings": 3, "last_seen": "...",
"rationale": "...",
"next_action": ["<trial command>", "zotero-research-library-pp-cli learnings confirm 12"] }
],
"playbook": {
"query_family": "...",
"playbook": {
"steps": [ { "cmd": "<command with {slot} substitution>", "purpose": "..." } ],
"entity_slots": ["$ENTITY"],
"expected_tool_calls": 3
},
"slots_resolved": { "$ENTITY": { "token": "<live token>", "canonical": "<canonical>" } },
"notes": "<workarounds + gotchas for this query family>"
},
"notes": "<duplicate surface for non-playbook callers>"
}
Empty-store short-circuit: if the store has no learnings, playbooks, or candidates yet (recall finds nothing and learnings list and learnings candidates are both empty), skip recall for the rest of this session instead of taxing every query; resume recall-first once something has been taught.
Step 2: decision tree
Read candidates, playbook, notes, results[0], and warnings in that order:
if Candidates present (warnings include "candidates_present"):
-> candidates are try-then-confirm, never facts. Follow each candidate's
two-step next_action verbatim: run the trial command first, then run
`learnings confirm <id>` only after the trial verified the behavior.
Reject a wrong candidate with `learnings reject <id>`.
-> NEVER re-teach something recall surfaced as a candidate; confirm or
reject that candidate instead of teaching a duplicate.
-> candidates ride alongside playbooks and resource hits, not instead of
them; continue with the branches below after acting on them.
if Playbook present:
-> READ Playbook.notes verbatim FIRST (workarounds + gotchas the CLI surface doesn't expose)
-> replay Playbook.steps in order, substituting Playbook.slots_resolved entries
for the entity slot tokens. If a step's slot is unresolved, fall back to
discovery for that step only.
-> the Playbook's expected_tool_calls is a budget; if you find yourself running
materially more, record the divergence via `zotero-research-library-pp-cli playbook amend`
at end-of-session.
elif Notes present (no Playbook):
-> read Notes verbatim before any discovery step; they carry known gotchas
for this query family even when no structured choreography exists yet.
elif Found AND Results[0].EntityMatch == "exact" AND Results[0].Confidence >= 2:
-> skip discovery; fetch live data for Results[*].ResourceID in parallel
elif Found AND Results[0].EntityMatch == "partial":
-> candidate hint, NOT a hit; read the resource title to validate before trusting
elif (any row in Mismatches[] when --debug-mismatches was passed):
-> treat as cold start; the stored learning is for a different entity
(different canonical resolved from query_entities)
else: // Found == false, no playbook, no notes
-> cold start; run discovery normally; teach the answer afterward (Step 4).
If the family has no playbook yet, that teach auto-synthesizes a
playbook candidate from this session's journal - you do not need to
record one by hand.
Playbook and Notes are orthogonal to the per-resource path. A recall response can carry both a Playbook AND a Results[] hit - use both: the Playbook tells you which choreography to run; the resource hits short-circuit specific steps. Default to skipping mismatches; pass --debug-mismatches only when investigating cold-start surprises.
Candidate judgment details: learnings confirm <id> prints the candidate's full payload before materializing it - check that the printed payload matches the behavior you verified. learnings reject <id> tombstones the derivation signature so the same candidate does not resurface. The envelope carries only the few candidates worth acting on now; zotero-research-library-pp-cli learnings candidates lists the full open set.
Graceful degradation: if learnings confirm is an unknown command, you are driving an older binary - ignore the candidates guidance and follow the rest of the protocol.
Step 3: always read warnings
low_confidence: row exists atconfidence<2. Treat as a hint, not a skip-discovery hit.resource_not_in_store: the local store doesn't have the resource the learning points at. The match validator couldn't classify entities — direct-fetch and re-evaluate.cross_alias_match(per-result): the row was taught under a different alias and matched the live query's canonical viaentity_lookups(e.g., a "USA" teach satisfying a "United States" recall). Trust the resource_id.similar_shape_different_entity:<canonical>(top-level): a structurally matching row exists but its canonical entity differs from the live query's. Treated as cold start; the warning carries the conflicting canonical as a hint, but the row is NOT promoted into Results.ambiguous_alias(top-level): a single query entity resolved to multiple canonicals (e.g., "Cards" → Arizona Cardinals + St. Louis Cardinals). Surface the ambiguity from context before committing to a resource.candidates_present(top-level): the envelope carries acandidatessection. Handle it via the candidates branch in Step 2 before anything else.lookup_refresh_available(top-level): an entity in the query has no lookup row yet, but synced data could provide one. Runzotero-research-library-pp-cli syncto refresh entity lookups.- Top-level
no_learnings_for_query_family: the table had no rows above the Jaccard floor. Pure cold start.
Step 4: teach & after finalizing your response - always
Teaching is unconditional. After resolving a query the store could not answer, background-teach the final resource mapping - no call-count threshold, no judging whether it was "worth" learning. The teach is the anchor of the loop: it triggers playbook synthesis for a family without a playbook, and same-referent phrasings fold into one family so near-duplicate teaches do not fragment the store. Fire it after assembling your user-facing response but BEFORE emitting it, with a shell & so the call returns immediately:
zotero-research-library-pp-cli teach --query "<user's question>" --resource-type <type> --resource <id1> --resource <id2>
# (append shell `&` to background it)
Silent on success. Errors only land in teach.log under the resolved state dir. Teach the most specific resource - if the user asked a broad question and you walked through parent records to find the specific answer, teach the leaf id, not the parent. The CLI uses seeded entity_lookups for cross-alias resolution at recall time, so a teach under one alias (e.g., "Niners") satisfies future queries under another alias (e.g., "49ers", "San Francisco") automatically.
PII rule: teach the structural question with identifiers stripped - never include names, emails, phone numbers, account ids, or other personal identifiers in taught queries or notes. The CLI scans teach queries for obvious email/phone shapes and warns, but does not block; strip before teaching rather than relying on the warning.
Step 5: playbooks - optional flags, automatic synthesis
You do not need to decide whether a session "deserves" a playbook: a teach on a family without one auto-synthesizes a playbook_candidate from the session's journal, and the next session judges it via confirm/reject. Attach explicit playbook flags only when you already hold choreography worth recording verbatim - workarounds the CLI didn't surface (silently-dropped flags, undocumented params, pagination tricks, payload gotchas). Prefer the integrated one-call form - record the resource learning and the playbook in the same teach invocation:
# Common case: record both the resource learning AND the playbook in one call.
zotero-research-library-pp-cli teach \
--query "<user's question>" \
--resource <id> \
--playbook-file ~/playbooks/<shape>.json \
--playbook-notes-file ~/playbooks/<shape>-notes.md
# (append shell `&` to background it)
# Alternate: playbook-only (no resource to record alongside).
zotero-research-library-pp-cli teach-playbook \
--query "<user's question>" \
--playbook-file ~/playbooks/<shape>.json \
--notes-file ~/playbooks/<shape>-notes.md
Playbook files are JSON with steps, entity_slots, expected_tool_calls. Notes files are markdown carrying the gotchas verbatim. File-free callers (MCP-only agents) pass the same content inline: --playbook-json and --playbook-notes on the integrated teach form, --playbook-json and --notes on teach-playbook. On the integrated teach form, the playbook flags are optional - omit them entirely for a resource-only teach. On the standalone teach-playbook form, at least one of the playbook and notes flags must be set; both empty is rejected. Playbooks are keyed on the structural query family (entities stripped) so a recipe taught from one entity-shaped query applies to every other query of the same shape, with slots_resolved binding the live query's canonical at recall time.
When you DO find a playbook on a future recall, treat it as ground truth: replay the steps with slots_resolved substitutions, skip the discovery that the choreography already documents, and read notes before any step.
Step 6: playbook amend & when your debug response identifies a correction
If your debug-protocol response identifies a concrete correction the notes or playbook should know — a workaround, an undocumented endpoint shape, a stale field name, observed schema drift, an empty-payload fallback — fire playbook amend BEFORE emitting your user-facing response. Same fire-and-forget posture as teach.
zotero-research-library-pp-cli playbook amend \
--query "<exact recall query string>" \
--add-note "<your concrete correction>"
# (append shell `&` to background it)
What counts as worth amending: a behavior you OBSERVED this session that future-you would benefit from knowing. Examples worth amending:
- A workaround for a CLI surface that silently drops or misorders a flag.
- An undocumented endpoint shape (response wrapped in
{meta, results}, payload nested two levels deeper than the docs claim). - Observed schema drift (a field renamed, an index that shifted between seasons, a category label that the API now returns lower-cased).
What does NOT belong in notes:
- The year-specific or entity-specific answer to the user's question. That's the response, not a learning.
- Per-team / per-athlete / per-row data the playbook already retrieves at runtime.
- Statements that paraphrase what the existing notes already say.
The amend command appends to the family's existing notes with a timestamped marker ([amend YYYY-MM-DDTHH:MMZ]: <text>). Multiple amends accumulate; the audit trail is visible. If no playbook exists yet for the family, amend creates a notes-only one (so cold-start corrections still land).
PII discipline for amend notes
playbook amend notes are designed to potentially flow upstream as shared knowledge in future versions of the Printing Press. Keep them clean of user-identifying content so the upstream-contribution path stays open without retroactive scrubbing:
- Do NOT embed paths to user filesystems, personal API keys or tokens, user email addresses, user GitHub handles, or specific query histories tied to a single user.
- Acceptable: endpoint shapes, undocumented field names, API gotchas, observed schema drift, workarounds for CLI surfaces, generalizable pagination or retry tactics.
If a correction is only meaningful with user-specific context, it belongs in a personal note, not in the playbook amend.
Measuring the loop
zotero-research-library-pp-cli learnings stats reports recall hit rate, teach-to-reuse, playbook resolution rate, and candidate confirm/reject counts from the local learn_events table. Rates are null until they have a denominator; everything stays on this machine. Use it to check whether the loop is earning its keep for this CLI.
Disabling learning
--no-learnon a single command short-circuits bothrecalland theteachwrite path. Use for deterministic agent flows or tests that must not be affected by accumulated learnings.ZOTERO_RESEARCH_LIBRARY_NO_LEARN=truein the environment globally disables the pipeline.
Agent Feedback
When you (or the agent) notice something off about this CLI, record it:
zotero-research-library-pp-cli feedback "the --since flag is inclusive but docs say exclusive"
zotero-research-library-pp-cli feedback --stdin < notes.txt
zotero-research-library-pp-cli feedback list --json --limit 10
Entries are stored locally as feedback.jsonl under the resolved data dir. They are never POSTed unless ZOTERO_RESEARCH_LIBRARY_FEEDBACK_ENDPOINT is set AND either --send is passed or ZOTERO_RESEARCH_LIBRARY_FEEDBACK_AUTO_SEND=true. Default behavior is local-only.
Write what surprised you, not a bug report. Short, specific, one line: that is the part that compounds.
Output Delivery
Every command accepts --deliver <sink>. The output goes to the named sink in addition to (or instead of) stdout, so agents can route command results without hand-piping. Three sinks are supported:
| Sink | Effect |
|---|---|
stdout |
Default; write to stdout only |
file:<path> |
Atomically write output to <path> (tmp + rename) |
webhook:<url> |
POST the output body to the URL (application/json or application/x-ndjson when --compact) |
Unknown schemes are refused with a structured error naming the supported set. Webhook failures return non-zero and log the URL + HTTP status on stderr.
Named Profiles
A profile is a saved set of flag values, reused across invocations. Use it when a scheduled or recurring agent reuses the same saved flags while providing different input each run.
zotero-research-library-pp-cli profile save briefing --json
zotero-research-library-pp-cli --profile briefing collections list
zotero-research-library-pp-cli profile list --json
zotero-research-library-pp-cli profile show briefing
zotero-research-library-pp-cli profile delete briefing --yes
Explicit flags always win over profile values; profile values win over defaults. agent-context lists all available profiles under available_profiles so introspecting agents discover them at runtime.
Exit Codes
| Code | Meaning |
|---|---|
| 0 | Success |
| 2 | Usage error (wrong arguments) |
| 3 | Resource not found |
| 4 | Authentication required |
| 5 | API error (upstream issue) |
| 7 | Rate limited (wait and retry) |
| 10 | Config error |
Argument Parsing
Parse $ARGUMENTS:
- Empty,
help, or--help→ showzotero-research-library-pp-cli --helpoutput - Starts with
install→ ends withmcp→ MCP installation; otherwise → see Prerequisites above - Anything else → Direct Use (execute as CLI command with
--agent)
MCP Server Installation
- Install the MCP server:
go install github.com/mvanhorn/printing-press-library/library/productivity/zotero-research-library/cmd/zotero-research-library-pp-mcp@latest - Register with Claude Code:
claude mcp add zotero-research-library-pp-mcp -- zotero-research-library-pp-mcp - Verify:
claude mcp list
Direct Use
- Check if installed:
which zotero-research-library-pp-cliIf not found, offer to install (see Prerequisites at the top of this skill). - Match the user query to the best command from the Unique Capabilities and Command Reference above.
- Execute with the
--agentflag:zotero-research-library-pp-cli <command> [subcommand] [args] --agent - If ambiguous, drill into subcommand help:
zotero-research-library-pp-cli <command> --help.