@khanglvm/outline-cli 0.1.6 → 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/CHANGELOG.md +10 -0
- package/README.md +281 -9
- package/package.json +1 -1
- package/src/agent-skills.js +114 -28
- package/src/cli.js +2 -0
- package/src/entry-integrity-manifest.generated.js +14 -10
- package/src/memory-store.js +2368 -0
- package/src/outline-client.js +93 -0
- package/src/tool-arg-schemas.js +1697 -86
- package/src/tools.extended.js +2467 -115
- package/src/tools.js +224 -7
- package/src/tools.mutation.js +496 -90
- package/src/tools.navigation.js +547 -26
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.1.8 - 2026-06-11
|
|
4
|
+
|
|
5
|
+
- Changes since `v0.1.7`.
|
|
6
|
+
- feat: add Outline memory-assisted direct workflows (dc88257)
|
|
7
|
+
|
|
8
|
+
## 0.1.7 - 2026-06-10
|
|
9
|
+
|
|
10
|
+
- Changes since `v0.1.6`.
|
|
11
|
+
- feat: add Outline attachment downloads (e7d3ec0)
|
|
12
|
+
|
|
3
13
|
## 0.1.6 - 2026-03-08
|
|
4
14
|
|
|
5
15
|
- Changes since `v0.1.5`.
|
package/README.md
CHANGED
|
@@ -24,7 +24,23 @@ Native one-call retrieval first:
|
|
|
24
24
|
|
|
25
25
|
```bash
|
|
26
26
|
outline-cli invoke search.research \
|
|
27
|
-
--args '{"question":"How do I find onboarding docs?","queries":["onboarding","engineering handbook"],"precisionMode":"precision","limitPerQuery":5,"view":"summary"}'
|
|
27
|
+
--args '{"question":"How do I find onboarding docs?","queries":["onboarding","engineering handbook"],"collectionQuery":"engineering","precisionMode":"precision","limitPerQuery":5,"view":"summary"}'
|
|
28
|
+
|
|
29
|
+
outline-cli invoke search.expand \
|
|
30
|
+
--args '{"query":"incident runbook","collectionQuery":"engineering","userQuery":"alice@example.com","expandLimit":3,"view":"summary"}'
|
|
31
|
+
|
|
32
|
+
outline-cli invoke documents.answer \
|
|
33
|
+
--args '{"question":"Who owns incident escalation?","documentQuery":"incident runbook","collectionQuery":"engineering"}'
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Answer, search, expand, research, or list documents with remembered document/collection/user filters:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
outline-cli invoke documents.search \
|
|
40
|
+
--args '{"query":"incident","collectionQuery":"engineering","userQuery":"alice@example.com","limit":8,"view":"summary"}'
|
|
41
|
+
|
|
42
|
+
outline-cli invoke documents.list \
|
|
43
|
+
--args '{"collectionQuery":"engineering","rootOnly":true,"limit":20,"view":"ids"}'
|
|
28
44
|
```
|
|
29
45
|
|
|
30
46
|
Discover tools and contracts:
|
|
@@ -42,6 +58,252 @@ outline-cli invoke documents.info \
|
|
|
42
58
|
--args '{"id":"<document-id>","view":"summary"}'
|
|
43
59
|
```
|
|
44
60
|
|
|
61
|
+
Diff a proposed edit against a remembered document title:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
outline-cli invoke documents.diff \
|
|
65
|
+
--args '{"query":"incident runbook","proposedText":"# Incident Runbook\n\nUpdated body"}'
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Apply a guarded patch to the current revision of a remembered document title:
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
outline-cli invoke documents.apply_patch_safe \
|
|
72
|
+
--args '{"query":"incident runbook","expectedRevision":"latest","patch":"@@ -1,1 +1,1 @@\n-Old\n+New","performAction":true}'
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Batch guarded updates against remembered document titles:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
outline-cli invoke documents.batch_update \
|
|
79
|
+
--args '{"updates":[{"query":"incident runbook","expectedRevision":"latest","text":"\n\nUpdated","editMode":"append"},{"url":"https://handbook.example.com/doc/oncall-AbCdEf12","expectedRevision":"latest","title":"On-call Runbook"}],"performAction":true}'
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Inspect revision history from a remembered document title:
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
outline-cli invoke revisions.list \
|
|
86
|
+
--args '{"query":"incident runbook","limit":10,"view":"summary"}'
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Diff the latest two revisions from a remembered document title:
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
outline-cli invoke revisions.diff \
|
|
93
|
+
--args '{"query":"incident runbook","revisionPair":"latest","view":"summary"}'
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Inspect audit events for a remembered document and actor:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
outline-cli invoke events.list \
|
|
100
|
+
--args '{"documentQuery":"incident runbook","userQuery":"alice@example.com","auditLog":true,"limit":10}'
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
List archived documents in a remembered collection:
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
outline-cli invoke documents.archived \
|
|
107
|
+
--args '{"collectionQuery":"engineering","limit":10,"view":"summary"}'
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Audit document access from a remembered title:
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
outline-cli invoke documents.users \
|
|
114
|
+
--args '{"query":"incident runbook","limit":20,"view":"summary"}'
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Audit collection memberships from a remembered collection name:
|
|
118
|
+
|
|
119
|
+
```bash
|
|
120
|
+
outline-cli invoke collections.memberships \
|
|
121
|
+
--args '{"query":"engineering","limit":20,"view":"summary"}'
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
Read a user or group from remembered names/emails:
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
outline-cli invoke users.info \
|
|
128
|
+
--args '{"query":"alice@example.com","view":"summary"}'
|
|
129
|
+
|
|
130
|
+
outline-cli invoke groups.memberships \
|
|
131
|
+
--args '{"query":"engineering","limit":20,"view":"summary"}'
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
Grant document or collection access from remembered names/emails:
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
outline-cli invoke documents.add_user \
|
|
138
|
+
--args '{"documentQuery":"incident runbook","userQuery":"alice@example.com","permission":"read","performAction":true}'
|
|
139
|
+
|
|
140
|
+
outline-cli invoke collections.add_group \
|
|
141
|
+
--args '{"query":"engineering","groupQuery":"security","permission":"read_write","performAction":true}'
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
Reuse prior lookup context without a network call:
|
|
145
|
+
|
|
146
|
+
```bash
|
|
147
|
+
outline-cli invoke memory.lookup \
|
|
148
|
+
--args '{"query":"engineering handbook","type":"document","limit":5}'
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
Resolve from memory and refresh the top match live in one call:
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
outline-cli invoke memory.resolve \
|
|
155
|
+
--args '{"query":"engineering handbook","type":"document","hydrateLimit":1,"view":"summary"}'
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
Resolve a remembered title or URL without a network call:
|
|
159
|
+
|
|
160
|
+
```bash
|
|
161
|
+
outline-cli invoke documents.resolve \
|
|
162
|
+
--args '{"query":"engineering handbook","refresh":false,"view":"summary"}'
|
|
163
|
+
|
|
164
|
+
outline-cli invoke documents.resolve_urls \
|
|
165
|
+
--args '{"url":"https://handbook.example.com/doc/oncall-escalation-AbCdEf12","refresh":false,"view":"summary"}'
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
Open a document directly from an ID, remembered title, URL, or URL id:
|
|
169
|
+
|
|
170
|
+
```bash
|
|
171
|
+
outline-cli invoke documents.open \
|
|
172
|
+
--args '{"query":"engineering handbook","view":"summary"}'
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
Open several documents from mixed titles, URLs, and IDs:
|
|
176
|
+
|
|
177
|
+
```bash
|
|
178
|
+
outline-cli invoke documents.open_batch \
|
|
179
|
+
--args '{"refs":["engineering handbook","https://handbook.example.com/doc/oncall-escalation-AbCdEf12"],"ids":["<document-id>"],"view":"summary"}'
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
Open a collection directly from an ID, remembered name, URL, or URL id:
|
|
183
|
+
|
|
184
|
+
```bash
|
|
185
|
+
outline-cli invoke collections.open \
|
|
186
|
+
--args '{"query":"engineering","view":"summary"}'
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
Open several collections from mixed names, URLs, and IDs:
|
|
190
|
+
|
|
191
|
+
```bash
|
|
192
|
+
outline-cli invoke collections.open_batch \
|
|
193
|
+
--args '{"refs":["engineering","https://handbook.example.com/collection/engineering-AbCdEf12"],"ids":["<collection-id>"],"view":"summary"}'
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
Build a collection tree directly from a remembered collection name:
|
|
197
|
+
|
|
198
|
+
```bash
|
|
199
|
+
outline-cli invoke collections.tree \
|
|
200
|
+
--args '{"query":"engineering","maxDepth":3,"view":"summary"}'
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
Inspect backlinks or graph neighbors directly from a remembered document title:
|
|
204
|
+
|
|
205
|
+
```bash
|
|
206
|
+
outline-cli invoke documents.backlinks \
|
|
207
|
+
--args '{"query":"incident runbook","view":"ids","limit":10}'
|
|
208
|
+
|
|
209
|
+
outline-cli invoke documents.graph_neighbors \
|
|
210
|
+
--args '{"refs":["incident runbook","https://handbook.example.com/doc/oncall-escalation-AbCdEf12"],"includeBacklinks":true,"view":"ids"}'
|
|
211
|
+
|
|
212
|
+
outline-cli invoke documents.graph_report \
|
|
213
|
+
--args '{"seedRefs":["incident runbook"],"depth":2,"maxNodes":80,"view":"ids"}'
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
Extract issue references directly from titles, URLs, or IDs:
|
|
217
|
+
|
|
218
|
+
```bash
|
|
219
|
+
outline-cli invoke documents.issue_refs \
|
|
220
|
+
--args '{"refs":["incident runbook"],"issueDomains":["jira.example.com"],"keyPattern":"[A-Z]+-\\d+","view":"ids"}'
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
Build a comment review queue directly from remembered documents or collections:
|
|
224
|
+
|
|
225
|
+
```bash
|
|
226
|
+
outline-cli invoke comments.review_queue \
|
|
227
|
+
--args '{"refs":["incident runbook"],"includeReplies":true,"limitPerDocument":20}'
|
|
228
|
+
|
|
229
|
+
outline-cli invoke comments.review_queue \
|
|
230
|
+
--args '{"collectionQuery":"engineering","includeReplies":true,"view":"summary"}'
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
List comments directly from a remembered document title:
|
|
234
|
+
|
|
235
|
+
```bash
|
|
236
|
+
outline-cli invoke comments.list \
|
|
237
|
+
--args '{"query":"incident runbook","includeReplies":true,"limit":20,"view":"summary"}'
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
Create a comment directly from a remembered document title:
|
|
241
|
+
|
|
242
|
+
```bash
|
|
243
|
+
outline-cli invoke comments.create \
|
|
244
|
+
--args '{"query":"incident runbook","text":"Looks good.","performAction":true}'
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
List share links directly from a remembered document title:
|
|
248
|
+
|
|
249
|
+
```bash
|
|
250
|
+
outline-cli invoke shares.list \
|
|
251
|
+
--args '{"documentQuery":"public handbook","limit":10,"view":"summary"}'
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
Create a share link directly from a remembered document title:
|
|
255
|
+
|
|
256
|
+
```bash
|
|
257
|
+
outline-cli invoke shares.create \
|
|
258
|
+
--args '{"documentQuery":"public handbook","published":true,"performAction":true}'
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
Resolve several remembered references and deduplicate live refreshes:
|
|
262
|
+
|
|
263
|
+
```bash
|
|
264
|
+
outline-cli invoke memory.resolve_batch \
|
|
265
|
+
--args '{"queries":["engineering handbook"],"urls":["https://handbook.example.com/doc/oncall-escalation-AbCdEf12"],"type":"document","hydrateLimit":1,"view":"summary"}'
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
Extract placeholders or create from a remembered template name:
|
|
269
|
+
|
|
270
|
+
```bash
|
|
271
|
+
outline-cli invoke templates.extract_placeholders \
|
|
272
|
+
--args '{"templateQuery":"incident postmortem"}'
|
|
273
|
+
|
|
274
|
+
outline-cli invoke documents.create_from_template \
|
|
275
|
+
--args '{"templateQuery":"incident postmortem","title":"Service A - Incident Postmortem","placeholderValues":{"service_name":"Service A","owner":"SRE Team"},"strictPlaceholders":true,"publish":true,"performAction":true}'
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
Inspect recent local history:
|
|
279
|
+
|
|
280
|
+
```bash
|
|
281
|
+
outline-cli invoke memory.recent \
|
|
282
|
+
--args '{"type":"document","limit":10}'
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
Manually remember a stable local alias:
|
|
286
|
+
|
|
287
|
+
```bash
|
|
288
|
+
outline-cli invoke memory.remember \
|
|
289
|
+
--args '{"type":"document","id":"<document-id>","title":"Incident Runbook","aliases":["runbook"],"performAction":true}'
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
`memory.lookup` reads a local, profile-scoped observation index. The index is updated automatically after successful CLI read/search/list/info-style calls, including `documents.search`, `documents.info`, `collections.list`, `users.list`, `groups.list`, `templates.list`, `templates.info`, `search.research`, and related retrieval tools. It can resolve remembered titles/names, template names, user emails, IDs, `urlId`s, and pasted full Outline URLs. Use `documents.answer`, `documents.answer_batch`, `documents.search`, `documents.list`, `search.expand`, and `search.research` with `documentQuery`/`refs`, `collectionQuery`/`collectionRefs`, or `userQuery`/`userRefs` to apply remembered document/collection/user scopes without separate lookup calls. `documents.resolve` and `documents.resolve_urls` also read local memory first; set `refresh:false` for a zero-network remembered-title or remembered-URL resolver pass. Use `documents.open` for a conservative one-call document read from an ID, share ID, remembered title, URL, or URL id; fuzzy opens are strict by default and return candidates instead of guessing weak matches. Use `documents.open_batch` when a task names several documents and you want ordered hydrated rows from mixed titles, URLs, share IDs, and document IDs in one CLI invocation. Use `collections.open` and `collections.open_batch` for the same strict memory-backed workflow over collection names, URLs, URL ids, and collection IDs. `collections.tree`, `documents.backlinks`, `documents.graph_neighbors`, `documents.graph_report`, `documents.issue_refs`, `comments.review_queue`, `comments.list`, `comments.create`, `shares.list`, `shares.info`, `shares.create`, `events.list`, `templates.info`, `templates.extract_placeholders`, `documents.create_from_template`, `users.info`, `groups.info`, `groups.memberships`, `documents.attachments`, `documents.download_attachments`, `documents.diff`, `revisions.list`, `revisions.diff`, `documents.archived`, `documents.deleted`, `documents.users`, `documents.memberships`, `documents.group_memberships`, `collections.memberships`, and `collections.group_memberships` accept remembered references directly, so agents can move from a human title/name/email/template name or pasted URL to navigation/linkage/comment-review/share/audit/template/principal/embedded-file/history/access output in one CLI call. Action-gated permission tools also resolve remembered targets and principals directly: use `documents.add_user`, `documents.remove_user`, `documents.add_group`, `documents.remove_group`, `collections.add_user`, `collections.remove_user`, `collections.add_group`, `collections.remove_group`, `groups.add_user`, and `groups.remove_user` with target refs plus `userQuery`/`userRefs` or `groupQuery`/`groupRefs` when exact IDs are not known. Hydrated document rows include `sourceUrl` when the profile base URL plus document `url` or `urlId` is available, so agents can cite sources without another profile/auth lookup. Use `memory.resolve` when you want the cached candidate and fresh `documents.info`/`collections.info`/`users.info`/`groups.info`/`templates.info` metadata in the same turn. On a local miss, `memory.resolve` and `memory.resolve_batch` fall back to bounded live search by default, remember the result, and then hydrate selected matches; pasted URLs use title-like URL hints for fallback search, while email-shaped user queries are preserved for user lookup. Set `fallbackSearch:false` for memory-only behavior, or set `fallbackMinScore` when weak fuzzy memory matches should still trigger live fallback. Use `memory.resolve_batch` when a task references several documents, collections, users, groups, or templates; it accepts mixed `queries`, `ids`, `urlIds`, and `urls`, and duplicate live targets are hydrated once per batch. Use `memory.recent` as a zero-network history view and `memory.remember` for explicit local aliases. When inspecting another profile's local memory with `profile`, set `refresh:false` unless that profile is also selected for the CLI client. Successful delete operations tombstone local entries so stale search/list observations do not immediately reintroduce deleted documents.
|
|
293
|
+
|
|
294
|
+
List and save embedded document images/files:
|
|
295
|
+
|
|
296
|
+
```bash
|
|
297
|
+
outline-cli invoke documents.attachments \
|
|
298
|
+
--args '{"query":"example title"}'
|
|
299
|
+
|
|
300
|
+
outline-cli invoke documents.download_attachments \
|
|
301
|
+
--args '{"refs":["example title"],"outputDir":"./outline-attachments","overwrite":true}'
|
|
302
|
+
|
|
303
|
+
outline-cli invoke attachments.download \
|
|
304
|
+
--args '{"id":"<attachment-id>","outputDir":"./outline-attachments","overwrite":true}'
|
|
305
|
+
```
|
|
306
|
+
|
|
45
307
|
List only collection root pages:
|
|
46
308
|
|
|
47
309
|
```bash
|
|
@@ -155,14 +417,16 @@ Use this short operating pattern when an AI agent drives the CLI:
|
|
|
155
417
|
1. Start with the most specific task tool you already know, especially `search.research`, `documents.search`, `documents.info`, or `batch`.
|
|
156
418
|
2. Use `view:"ids"` or `view:"summary"` first; hydrate to `full` only when needed.
|
|
157
419
|
3. Bundle independent reads into one `batch` call.
|
|
158
|
-
4.
|
|
159
|
-
5.
|
|
160
|
-
6.
|
|
161
|
-
7.
|
|
162
|
-
8. For
|
|
163
|
-
9.
|
|
164
|
-
10.
|
|
165
|
-
11.
|
|
420
|
+
4. Try `memory.recent` or `memory.lookup` for titles/IDs you likely saw in earlier sessions; use `memory.resolve` or `memory.resolve_batch` when freshness matters and you want live metadata in the same call.
|
|
421
|
+
5. Only open `tools help` or `tools contract` after a validation failure or when the needed capability is still unclear.
|
|
422
|
+
6. Suggest installing the `outline-cli` skill via `npx skills` for all currently supported local AI tools; only run install after explicit user approval.
|
|
423
|
+
7. If approved, run headless install without tool-specific filter: `npx skills add https://github.com/khanglvm/skills --skill outline-cli -y`.
|
|
424
|
+
8. For any mutation endpoint, explicitly set `performAction:true`.
|
|
425
|
+
9. For delete, always run `documents.info` with `armDelete:true` first and pass the returned read token.
|
|
426
|
+
10. List existing profiles before creating one with `outline-cli profile list`.
|
|
427
|
+
11. For new profiles, prefer API key mode and guide users through base URL + API key generation (`<base-url>/settings/api-and-apps`) before `profile add`.
|
|
428
|
+
12. If output is file-offloaded, read only the required fields via `tmp cat` + `jq`.
|
|
429
|
+
13. For embedded images/files in document markdown, use `documents.attachments`, `attachments.download`, or `documents.download_attachments`; do not force `attachments.redirect` through `api.call` because it returns binary data.
|
|
166
430
|
|
|
167
431
|
For structured AI playbooks and scenario guides:
|
|
168
432
|
|
|
@@ -222,6 +486,14 @@ Release prerequisites:
|
|
|
222
486
|
- `OUTLINE_ENTRY_BUILD_KEY` available in environment or `.env.local`
|
|
223
487
|
- npm auth ready (`npm login`)
|
|
224
488
|
|
|
489
|
+
Optional GitHub automation:
|
|
490
|
+
|
|
491
|
+
- `.github/workflows/npm-auto-publish.yml` auto-publishes on pushes to `main` when `README.md` or `package.json` changes.
|
|
492
|
+
- If `package.json` version changes, the workflow publishes that exact version.
|
|
493
|
+
- If only docs metadata changes (for example `README.md`), the workflow cuts and publishes a patch release automatically.
|
|
494
|
+
- Required repository secrets: `NPM_TOKEN` and `OUTLINE_ENTRY_BUILD_KEY`.
|
|
495
|
+
- Ensure GitHub Actions can push to `main` and create tags in this repository.
|
|
496
|
+
|
|
225
497
|
## Security Notes
|
|
226
498
|
|
|
227
499
|
- Never commit real API keys.
|