papiers 0.1.5 → 0.1.8

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "papiers",
3
- "version": "0.1.5",
3
+ "version": "0.1.8",
4
4
  "description": "Read-only CLI for your Papiers library.",
5
5
  "license": "UNLICENSED",
6
6
  "homepage": "https://papiers.ai",
@@ -85,6 +85,9 @@ once for the full contract. `PAPIERS_TOKEN` must be configured.
85
85
 
86
86
  Most highlights carry no annotation (quote-only); `annotationText` is
87
87
  only present on reads, so read the highlights you intend to lean on.
88
+ It contains sanitized Markdown source, including emphasis markers, escapes,
89
+ and backticks; interpret those as part of the user's note. The read's
90
+ `format` describes the quoted content, not the annotation's syntax.
88
91
 
89
92
  5. **Write the judgement brief.** Before generating anything, summarize what
90
93
  you found: verbatim annotations with dates and IDs, stances, open
@@ -111,8 +114,32 @@ once for the full contract. `PAPIERS_TOKEN` must be configured.
111
114
  ISO timestamps or `30d`-style shorthand.
112
115
  - **Honor the quality signal.** `quality.signal: "empty"` or `"low"` means
113
116
  the library has nothing — report that rather than citing weak matches.
114
- - **Cite IDs.** `hl_/cnv_/doc_/pas_/eq_/nte_` IDs are stable; include them so the
115
- user can jump to sources.
117
+ - **Cite IDs.** Include `doc_/hl_/cnv_/nte_` IDs so the user can jump to
118
+ sources. A passage or equation is a place in a document plus a fingerprint
119
+ of its text (`'doc_<id>#p12.3f9c01aa'`); if its text has changed since you got
120
+ it, Papiers reports `stale_reference` — search or read the document again.
121
+ Quote these references in the shell: some shells treat `#` specially.
122
+ - **Import only what the user approved.** `papiers import URL` needs a token
123
+ with "Allow document imports". Show the user the exact URLs first. An import
124
+ is queued until `papiers import-status OPERATION_ID` says `ready`, which
125
+ means `papiers read` works on its `documentId`; don't call it added before
126
+ then. On `failed`, report `error.message`; retry only if `error.retryable`.
127
+ - **Highlight only what the user asked for or approved.** `papiers highlight
128
+ DOC_ID --start "..." [--end "..."]` needs a token with "Allow highlights".
129
+ In a PDF, name what you read: `--passage` with the search result's passage
130
+ reference, or `--pages` with the pages you read; a webpage needs neither. Give the
131
+ passage's first words as `--start` and, for a longer passage or one crossing
132
+ a formula, its last words as `--end`; both as you read them, on plain words:
133
+ keep math, even a single symbol like V, out of both (formatting doesn't
134
+ matter). If it repeats, add words until unique.
135
+ - **Add to the user's Discover feed what you think they'd want to read.**
136
+ `papiers feed add URL --reason "..."` needs a token with "Allow adding to
137
+ your Discover feed". It puts the link in their own Discover feed in Papiers,
138
+ labeled with your token's name and your reason; it never touches their
139
+ library. Give a reason in your own words: why this user, given what you
140
+ know of them. Public pages only (not paywalled, nothing private in the
141
+ link). It shows once Papiers has prepared it, usually within minutes;
142
+ sending it again answers how it is now.
116
143
  - **Budgets are policy, not protocol.** Default to ~10–20 queries and 3–8
117
144
  document reads per task. The user may override any policy in this skill
118
145
  (read more, weight recency differently, skip curation); the loop's shape