papiers 0.1.2 → 0.1.4
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/README.md +27 -3
- package/dist/index.js +1090 -402
- package/package.json +3 -2
- package/skills/papiers-research/SKILL.md +119 -0
package/README.md
CHANGED
|
@@ -15,19 +15,43 @@ Requires Node.js 22 or newer.
|
|
|
15
15
|
In Papiers, open Settings -> API tokens, create a token, then sign in:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
|
-
papiers auth login
|
|
18
|
+
papiers auth login
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
Paste the token when prompted. The CLI saves it locally so you do not need to
|
|
22
22
|
paste it again.
|
|
23
23
|
|
|
24
|
+
## Use with an AI agent
|
|
25
|
+
|
|
26
|
+
This is what `papiers` is really for. Point a coding or research agent (Claude
|
|
27
|
+
Code, Cursor, your own harness) at the CLI and it can ground its work in *your
|
|
28
|
+
own reading* — the papers you saved, the passages you highlighted, the notes
|
|
29
|
+
you wrote, the conversations you had — instead of generic web knowledge.
|
|
30
|
+
|
|
31
|
+
The package ships a ready-to-use agent skill at
|
|
32
|
+
[`skills/papiers-research/SKILL.md`](skills/papiers-research/SKILL.md). It
|
|
33
|
+
encodes the loop — survey what you've been reading, search across passages +
|
|
34
|
+
highlights + notes + conversations in one ranking, then read and cite your own
|
|
35
|
+
sources.
|
|
36
|
+
Hand that file to your agent (or drop it in its skills directory) and ask it to
|
|
37
|
+
propose an idea, design an experiment, or review a draft. It will think with
|
|
38
|
+
your library, not around it.
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
# the agent only needs your token in its environment:
|
|
42
|
+
export PAPIERS_TOKEN=pap_live_...
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Every data command emits a stable JSON envelope (`--json` makes errors JSON
|
|
46
|
+
too), so an agent can learn the whole tool from `papiers --help --all` alone.
|
|
47
|
+
|
|
24
48
|
## Common Commands
|
|
25
49
|
|
|
26
50
|
```bash
|
|
27
|
-
papiers capabilities
|
|
28
51
|
papiers list --kind document --limit 5
|
|
29
52
|
papiers search "retrieval augmented generation" --limit 10
|
|
30
53
|
papiers read doc_... --format markdown
|
|
54
|
+
papiers doctor # check your setup and connection
|
|
31
55
|
```
|
|
32
56
|
|
|
33
57
|
Use `--json` for stable machine-readable output. Use `--ids`, `--ids0`, and
|
|
@@ -35,4 +59,4 @@ Use `--json` for stable machine-readable output. Use `--ids`, `--ids0`, and
|
|
|
35
59
|
|
|
36
60
|
## Automation
|
|
37
61
|
|
|
38
|
-
For
|
|
62
|
+
For scripts and automation, set `PAPIERS_TOKEN` and pass `--json` for stable machine-readable output.
|