@nickchristensen/ppls 1.0.1

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.
Files changed (107) hide show
  1. package/README.md +1190 -0
  2. package/bin/dev.cmd +3 -0
  3. package/bin/dev.js +5 -0
  4. package/bin/run.cmd +3 -0
  5. package/bin/run.js +5 -0
  6. package/dist/add-command.d.ts +24 -0
  7. package/dist/add-command.js +47 -0
  8. package/dist/base-command.d.ts +63 -0
  9. package/dist/base-command.js +306 -0
  10. package/dist/commands/config/get.d.ts +11 -0
  11. package/dist/commands/config/get.js +34 -0
  12. package/dist/commands/config/init.d.ts +15 -0
  13. package/dist/commands/config/init.js +43 -0
  14. package/dist/commands/config/list.d.ts +13 -0
  15. package/dist/commands/config/list.js +64 -0
  16. package/dist/commands/config/remove.d.ts +11 -0
  17. package/dist/commands/config/remove.js +26 -0
  18. package/dist/commands/config/set.d.ts +12 -0
  19. package/dist/commands/config/set.js +58 -0
  20. package/dist/commands/correspondents/add.d.ts +12 -0
  21. package/dist/commands/correspondents/add.js +20 -0
  22. package/dist/commands/correspondents/delete.d.ts +16 -0
  23. package/dist/commands/correspondents/delete.js +18 -0
  24. package/dist/commands/correspondents/list.d.ts +9 -0
  25. package/dist/commands/correspondents/list.js +15 -0
  26. package/dist/commands/correspondents/show.d.ts +14 -0
  27. package/dist/commands/correspondents/show.js +17 -0
  28. package/dist/commands/correspondents/update.d.ts +18 -0
  29. package/dist/commands/correspondents/update.js +24 -0
  30. package/dist/commands/custom-fields/add.d.ts +16 -0
  31. package/dist/commands/custom-fields/add.js +91 -0
  32. package/dist/commands/custom-fields/delete.d.ts +16 -0
  33. package/dist/commands/custom-fields/delete.js +18 -0
  34. package/dist/commands/custom-fields/list.d.ts +9 -0
  35. package/dist/commands/custom-fields/list.js +12 -0
  36. package/dist/commands/custom-fields/show.d.ts +14 -0
  37. package/dist/commands/custom-fields/show.js +17 -0
  38. package/dist/commands/custom-fields/update.d.ts +20 -0
  39. package/dist/commands/custom-fields/update.js +93 -0
  40. package/dist/commands/document-types/add.d.ts +12 -0
  41. package/dist/commands/document-types/add.js +22 -0
  42. package/dist/commands/document-types/delete.d.ts +16 -0
  43. package/dist/commands/document-types/delete.js +18 -0
  44. package/dist/commands/document-types/list.d.ts +9 -0
  45. package/dist/commands/document-types/list.js +12 -0
  46. package/dist/commands/document-types/show.d.ts +14 -0
  47. package/dist/commands/document-types/show.js +17 -0
  48. package/dist/commands/document-types/update.d.ts +18 -0
  49. package/dist/commands/document-types/update.js +26 -0
  50. package/dist/commands/documents/add.d.ts +70 -0
  51. package/dist/commands/documents/add.js +166 -0
  52. package/dist/commands/documents/delete.d.ts +16 -0
  53. package/dist/commands/documents/delete.js +18 -0
  54. package/dist/commands/documents/download.d.ts +48 -0
  55. package/dist/commands/documents/download.js +152 -0
  56. package/dist/commands/documents/list.d.ts +9 -0
  57. package/dist/commands/documents/list.js +14 -0
  58. package/dist/commands/documents/show.d.ts +14 -0
  59. package/dist/commands/documents/show.js +19 -0
  60. package/dist/commands/documents/update.d.ts +25 -0
  61. package/dist/commands/documents/update.js +42 -0
  62. package/dist/commands/profile.d.ts +13 -0
  63. package/dist/commands/profile.js +19 -0
  64. package/dist/commands/tags/add.d.ts +17 -0
  65. package/dist/commands/tags/add.js +29 -0
  66. package/dist/commands/tags/delete.d.ts +16 -0
  67. package/dist/commands/tags/delete.js +18 -0
  68. package/dist/commands/tags/list.d.ts +10 -0
  69. package/dist/commands/tags/list.js +18 -0
  70. package/dist/commands/tags/show.d.ts +16 -0
  71. package/dist/commands/tags/show.js +24 -0
  72. package/dist/commands/tags/update.d.ts +21 -0
  73. package/dist/commands/tags/update.js +30 -0
  74. package/dist/delete-command.d.ts +20 -0
  75. package/dist/delete-command.js +48 -0
  76. package/dist/helpers/config-store.d.ts +4 -0
  77. package/dist/helpers/config-store.js +35 -0
  78. package/dist/helpers/date-utils.d.ts +3 -0
  79. package/dist/helpers/date-utils.js +27 -0
  80. package/dist/helpers/table.d.ts +20 -0
  81. package/dist/helpers/table.js +42 -0
  82. package/dist/index.d.ts +1 -0
  83. package/dist/index.js +1 -0
  84. package/dist/list-command.d.ts +49 -0
  85. package/dist/list-command.js +98 -0
  86. package/dist/paginated-command.d.ts +48 -0
  87. package/dist/paginated-command.js +89 -0
  88. package/dist/show-command.d.ts +27 -0
  89. package/dist/show-command.js +50 -0
  90. package/dist/types/correspondents.d.ts +28 -0
  91. package/dist/types/correspondents.js +1 -0
  92. package/dist/types/custom-fields.d.ts +18 -0
  93. package/dist/types/custom-fields.js +1 -0
  94. package/dist/types/document-types.d.ts +27 -0
  95. package/dist/types/document-types.js +1 -0
  96. package/dist/types/documents.d.ts +70 -0
  97. package/dist/types/documents.js +1 -0
  98. package/dist/types/profile.d.ts +15 -0
  99. package/dist/types/profile.js +1 -0
  100. package/dist/types/shared.d.ts +4 -0
  101. package/dist/types/shared.js +1 -0
  102. package/dist/types/tags.d.ts +31 -0
  103. package/dist/types/tags.js +1 -0
  104. package/dist/update-command.d.ts +28 -0
  105. package/dist/update-command.js +51 -0
  106. package/oclif.manifest.json +3313 -0
  107. package/package.json +87 -0
package/oclif.manifest.json ADDED
@@ -0,0 +1,3313 @@
1
+ {
2
+ "commands": {
3
+ "profile": {
4
+ "aliases": [
5
+ "whoami"
6
+ ],
7
+ "args": {},
8
+ "description": "Show profile details",
9
+ "examples": [
10
+ "<%= config.bin %> <%= command.id %>"
11
+ ],
12
+ "flags": {
13
+ "json": {
14
+ "description": "Format output as json.",
15
+ "helpGroup": "GLOBAL",
16
+ "name": "json",
17
+ "allowNo": false,
18
+ "type": "boolean"
19
+ },
20
+ "date-format": {
21
+ "description": "Format output dates using a template.",
22
+ "env": "PPLS_DATE_FORMAT",
23
+ "helpGroup": "GLOBAL",
24
+ "name": "date-format",
25
+ "default": "yyyy-MM-dd",
26
+ "hasDynamicHelp": false,
27
+ "multiple": false,
28
+ "type": "option"
29
+ },
30
+ "header": {
31
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
32
+ "env": "PPLS_HEADERS",
33
+ "helpGroup": "ENVIRONMENT",
34
+ "name": "header",
35
+ "hasDynamicHelp": false,
36
+ "multiple": true,
37
+ "type": "option"
38
+ },
39
+ "hostname": {
40
+ "description": "Paperless-ngx base URL",
41
+ "env": "PPLS_HOSTNAME",
42
+ "helpGroup": "ENVIRONMENT",
43
+ "name": "hostname",
44
+ "hasDynamicHelp": false,
45
+ "multiple": false,
46
+ "type": "option"
47
+ },
48
+ "plain": {
49
+ "description": "Format output as plain text.",
50
+ "exclusive": [
51
+ "json",
52
+ "table"
53
+ ],
54
+ "helpGroup": "GLOBAL",
55
+ "name": "plain",
56
+ "allowNo": false,
57
+ "type": "boolean"
58
+ },
59
+ "table": {
60
+ "description": "Format output as table.",
61
+ "exclusive": [
62
+ "json",
63
+ "plain"
64
+ ],
65
+ "helpGroup": "GLOBAL",
66
+ "name": "table",
67
+ "allowNo": false,
68
+ "type": "boolean"
69
+ },
70
+ "token": {
71
+ "description": "Paperless-ngx API token",
72
+ "env": "PPLS_TOKEN",
73
+ "helpGroup": "ENVIRONMENT",
74
+ "name": "token",
75
+ "hasDynamicHelp": false,
76
+ "multiple": false,
77
+ "type": "option"
78
+ }
79
+ },
80
+ "hasDynamicHelp": false,
81
+ "hiddenAliases": [],
82
+ "id": "profile",
83
+ "pluginAlias": "@nickchristensen/ppls",
84
+ "pluginName": "@nickchristensen/ppls",
85
+ "pluginType": "core",
86
+ "strict": true,
87
+ "isESM": true,
88
+ "relativePath": [
89
+ "dist",
90
+ "commands",
91
+ "profile.js"
92
+ ]
93
+ },
94
+ "config:get": {
95
+ "aliases": [],
96
+ "args": {
97
+ "key": {
98
+ "description": "Config key",
99
+ "name": "key",
100
+ "required": true
101
+ }
102
+ },
103
+ "description": "Get a config value",
104
+ "examples": [
105
+ "<%= config.bin %> <%= command.id %> hostname"
106
+ ],
107
+ "flags": {
108
+ "json": {
109
+ "description": "Format output as json.",
110
+ "helpGroup": "GLOBAL",
111
+ "name": "json",
112
+ "allowNo": false,
113
+ "type": "boolean"
114
+ }
115
+ },
116
+ "hasDynamicHelp": false,
117
+ "hiddenAliases": [],
118
+ "id": "config:get",
119
+ "pluginAlias": "@nickchristensen/ppls",
120
+ "pluginName": "@nickchristensen/ppls",
121
+ "pluginType": "core",
122
+ "strict": true,
123
+ "enableJsonFlag": true,
124
+ "isESM": true,
125
+ "relativePath": [
126
+ "dist",
127
+ "commands",
128
+ "config",
129
+ "get.js"
130
+ ]
131
+ },
132
+ "config:init": {
133
+ "aliases": [],
134
+ "args": {},
135
+ "description": "Initialize a config file",
136
+ "examples": [
137
+ "<%= config.bin %> <%= command.id %>"
138
+ ],
139
+ "flags": {
140
+ "json": {
141
+ "description": "Format output as json.",
142
+ "helpGroup": "GLOBAL",
143
+ "name": "json",
144
+ "allowNo": false,
145
+ "type": "boolean"
146
+ },
147
+ "force": {
148
+ "char": "f",
149
+ "description": "Overwrite existing config file",
150
+ "name": "force",
151
+ "allowNo": false,
152
+ "type": "boolean"
153
+ }
154
+ },
155
+ "hasDynamicHelp": false,
156
+ "hiddenAliases": [],
157
+ "id": "config:init",
158
+ "pluginAlias": "@nickchristensen/ppls",
159
+ "pluginName": "@nickchristensen/ppls",
160
+ "pluginType": "core",
161
+ "strict": true,
162
+ "enableJsonFlag": true,
163
+ "isESM": true,
164
+ "relativePath": [
165
+ "dist",
166
+ "commands",
167
+ "config",
168
+ "init.js"
169
+ ]
170
+ },
171
+ "config:list": {
172
+ "aliases": [],
173
+ "args": {},
174
+ "description": "List config values",
175
+ "examples": [
176
+ "<%= config.bin %> <%= command.id %>"
177
+ ],
178
+ "flags": {
179
+ "json": {
180
+ "description": "Format output as json.",
181
+ "helpGroup": "GLOBAL",
182
+ "name": "json",
183
+ "allowNo": false,
184
+ "type": "boolean"
185
+ },
186
+ "plain": {
187
+ "description": "Format output as plain text.",
188
+ "exclusive": [
189
+ "json",
190
+ "table"
191
+ ],
192
+ "name": "plain",
193
+ "allowNo": false,
194
+ "type": "boolean"
195
+ },
196
+ "table": {
197
+ "description": "Format output as table.",
198
+ "exclusive": [
199
+ "json",
200
+ "plain"
201
+ ],
202
+ "name": "table",
203
+ "allowNo": false,
204
+ "type": "boolean"
205
+ }
206
+ },
207
+ "hasDynamicHelp": false,
208
+ "hiddenAliases": [],
209
+ "id": "config:list",
210
+ "pluginAlias": "@nickchristensen/ppls",
211
+ "pluginName": "@nickchristensen/ppls",
212
+ "pluginType": "core",
213
+ "strict": true,
214
+ "enableJsonFlag": true,
215
+ "isESM": true,
216
+ "relativePath": [
217
+ "dist",
218
+ "commands",
219
+ "config",
220
+ "list.js"
221
+ ]
222
+ },
223
+ "config:remove": {
224
+ "aliases": [],
225
+ "args": {
226
+ "key": {
227
+ "description": "Config key",
228
+ "name": "key",
229
+ "required": true
230
+ }
231
+ },
232
+ "description": "Remove a config value",
233
+ "examples": [
234
+ "<%= config.bin %> <%= command.id %> token"
235
+ ],
236
+ "flags": {
237
+ "json": {
238
+ "description": "Format output as json.",
239
+ "helpGroup": "GLOBAL",
240
+ "name": "json",
241
+ "allowNo": false,
242
+ "type": "boolean"
243
+ }
244
+ },
245
+ "hasDynamicHelp": false,
246
+ "hiddenAliases": [],
247
+ "id": "config:remove",
248
+ "pluginAlias": "@nickchristensen/ppls",
249
+ "pluginName": "@nickchristensen/ppls",
250
+ "pluginType": "core",
251
+ "strict": true,
252
+ "enableJsonFlag": true,
253
+ "isESM": true,
254
+ "relativePath": [
255
+ "dist",
256
+ "commands",
257
+ "config",
258
+ "remove.js"
259
+ ]
260
+ },
261
+ "config:set": {
262
+ "aliases": [],
263
+ "args": {
264
+ "key": {
265
+ "description": "Config key",
266
+ "name": "key",
267
+ "required": true
268
+ },
269
+ "value": {
270
+ "description": "Config value",
271
+ "name": "value",
272
+ "required": true
273
+ }
274
+ },
275
+ "description": "Set a config value",
276
+ "examples": [
277
+ "<%= config.bin %> <%= command.id %> hostname https://paperless.example.com",
278
+ "<%= config.bin %> <%= command.id %> headers '{\"X-Api-Key\":\"token\"}'"
279
+ ],
280
+ "flags": {
281
+ "json": {
282
+ "description": "Format output as json.",
283
+ "helpGroup": "GLOBAL",
284
+ "name": "json",
285
+ "allowNo": false,
286
+ "type": "boolean"
287
+ }
288
+ },
289
+ "hasDynamicHelp": false,
290
+ "hiddenAliases": [],
291
+ "id": "config:set",
292
+ "pluginAlias": "@nickchristensen/ppls",
293
+ "pluginName": "@nickchristensen/ppls",
294
+ "pluginType": "core",
295
+ "strict": true,
296
+ "enableJsonFlag": true,
297
+ "isESM": true,
298
+ "relativePath": [
299
+ "dist",
300
+ "commands",
301
+ "config",
302
+ "set.js"
303
+ ]
304
+ },
305
+ "correspondents:add": {
306
+ "aliases": [],
307
+ "args": {
308
+ "name": {
309
+ "description": "Correspondent name",
310
+ "name": "name",
311
+ "required": true
312
+ }
313
+ },
314
+ "description": "Create a correspondent",
315
+ "examples": [
316
+ "<%= config.bin %> <%= command.id %> \"Acme Corp\""
317
+ ],
318
+ "flags": {
319
+ "json": {
320
+ "description": "Format output as json.",
321
+ "helpGroup": "GLOBAL",
322
+ "name": "json",
323
+ "allowNo": false,
324
+ "type": "boolean"
325
+ },
326
+ "date-format": {
327
+ "description": "Format output dates using a template.",
328
+ "env": "PPLS_DATE_FORMAT",
329
+ "helpGroup": "GLOBAL",
330
+ "name": "date-format",
331
+ "default": "yyyy-MM-dd",
332
+ "hasDynamicHelp": false,
333
+ "multiple": false,
334
+ "type": "option"
335
+ },
336
+ "header": {
337
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
338
+ "env": "PPLS_HEADERS",
339
+ "helpGroup": "ENVIRONMENT",
340
+ "name": "header",
341
+ "hasDynamicHelp": false,
342
+ "multiple": true,
343
+ "type": "option"
344
+ },
345
+ "hostname": {
346
+ "description": "Paperless-ngx base URL",
347
+ "env": "PPLS_HOSTNAME",
348
+ "helpGroup": "ENVIRONMENT",
349
+ "name": "hostname",
350
+ "hasDynamicHelp": false,
351
+ "multiple": false,
352
+ "type": "option"
353
+ },
354
+ "plain": {
355
+ "description": "Format output as plain text.",
356
+ "exclusive": [
357
+ "json",
358
+ "table"
359
+ ],
360
+ "helpGroup": "GLOBAL",
361
+ "name": "plain",
362
+ "allowNo": false,
363
+ "type": "boolean"
364
+ },
365
+ "table": {
366
+ "description": "Format output as table.",
367
+ "exclusive": [
368
+ "json",
369
+ "plain"
370
+ ],
371
+ "helpGroup": "GLOBAL",
372
+ "name": "table",
373
+ "allowNo": false,
374
+ "type": "boolean"
375
+ },
376
+ "token": {
377
+ "description": "Paperless-ngx API token",
378
+ "env": "PPLS_TOKEN",
379
+ "helpGroup": "ENVIRONMENT",
380
+ "name": "token",
381
+ "hasDynamicHelp": false,
382
+ "multiple": false,
383
+ "type": "option"
384
+ }
385
+ },
386
+ "hasDynamicHelp": false,
387
+ "hiddenAliases": [],
388
+ "id": "correspondents:add",
389
+ "pluginAlias": "@nickchristensen/ppls",
390
+ "pluginName": "@nickchristensen/ppls",
391
+ "pluginType": "core",
392
+ "strict": true,
393
+ "isESM": true,
394
+ "relativePath": [
395
+ "dist",
396
+ "commands",
397
+ "correspondents",
398
+ "add.js"
399
+ ]
400
+ },
401
+ "correspondents:delete": {
402
+ "aliases": [],
403
+ "args": {
404
+ "id": {
405
+ "description": "Correspondent id",
406
+ "name": "id",
407
+ "required": true
408
+ }
409
+ },
410
+ "description": "Delete a correspondent",
411
+ "examples": [
412
+ "<%= config.bin %> <%= command.id %> 123"
413
+ ],
414
+ "flags": {
415
+ "json": {
416
+ "description": "Format output as json.",
417
+ "helpGroup": "GLOBAL",
418
+ "name": "json",
419
+ "allowNo": false,
420
+ "type": "boolean"
421
+ },
422
+ "date-format": {
423
+ "description": "Format output dates using a template.",
424
+ "env": "PPLS_DATE_FORMAT",
425
+ "helpGroup": "GLOBAL",
426
+ "name": "date-format",
427
+ "default": "yyyy-MM-dd",
428
+ "hasDynamicHelp": false,
429
+ "multiple": false,
430
+ "type": "option"
431
+ },
432
+ "header": {
433
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
434
+ "env": "PPLS_HEADERS",
435
+ "helpGroup": "ENVIRONMENT",
436
+ "name": "header",
437
+ "hasDynamicHelp": false,
438
+ "multiple": true,
439
+ "type": "option"
440
+ },
441
+ "hostname": {
442
+ "description": "Paperless-ngx base URL",
443
+ "env": "PPLS_HOSTNAME",
444
+ "helpGroup": "ENVIRONMENT",
445
+ "name": "hostname",
446
+ "hasDynamicHelp": false,
447
+ "multiple": false,
448
+ "type": "option"
449
+ },
450
+ "plain": {
451
+ "description": "Format output as plain text.",
452
+ "exclusive": [
453
+ "json",
454
+ "table"
455
+ ],
456
+ "helpGroup": "GLOBAL",
457
+ "name": "plain",
458
+ "allowNo": false,
459
+ "type": "boolean"
460
+ },
461
+ "table": {
462
+ "description": "Format output as table.",
463
+ "exclusive": [
464
+ "json",
465
+ "plain"
466
+ ],
467
+ "helpGroup": "GLOBAL",
468
+ "name": "table",
469
+ "allowNo": false,
470
+ "type": "boolean"
471
+ },
472
+ "token": {
473
+ "description": "Paperless-ngx API token",
474
+ "env": "PPLS_TOKEN",
475
+ "helpGroup": "ENVIRONMENT",
476
+ "name": "token",
477
+ "hasDynamicHelp": false,
478
+ "multiple": false,
479
+ "type": "option"
480
+ },
481
+ "yes": {
482
+ "char": "y",
483
+ "description": "Skip confirmation prompt",
484
+ "name": "yes",
485
+ "allowNo": false,
486
+ "type": "boolean"
487
+ }
488
+ },
489
+ "hasDynamicHelp": false,
490
+ "hiddenAliases": [],
491
+ "id": "correspondents:delete",
492
+ "pluginAlias": "@nickchristensen/ppls",
493
+ "pluginName": "@nickchristensen/ppls",
494
+ "pluginType": "core",
495
+ "strict": true,
496
+ "isESM": true,
497
+ "relativePath": [
498
+ "dist",
499
+ "commands",
500
+ "correspondents",
501
+ "delete.js"
502
+ ]
503
+ },
504
+ "correspondents:list": {
505
+ "aliases": [],
506
+ "args": {},
507
+ "description": "List correspondents",
508
+ "examples": [
509
+ "<%= config.bin %> <%= command.id %>"
510
+ ],
511
+ "flags": {
512
+ "json": {
513
+ "description": "Format output as json.",
514
+ "helpGroup": "GLOBAL",
515
+ "name": "json",
516
+ "allowNo": false,
517
+ "type": "boolean"
518
+ },
519
+ "date-format": {
520
+ "description": "Format output dates using a template.",
521
+ "env": "PPLS_DATE_FORMAT",
522
+ "helpGroup": "GLOBAL",
523
+ "name": "date-format",
524
+ "default": "yyyy-MM-dd",
525
+ "hasDynamicHelp": false,
526
+ "multiple": false,
527
+ "type": "option"
528
+ },
529
+ "header": {
530
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
531
+ "env": "PPLS_HEADERS",
532
+ "helpGroup": "ENVIRONMENT",
533
+ "name": "header",
534
+ "hasDynamicHelp": false,
535
+ "multiple": true,
536
+ "type": "option"
537
+ },
538
+ "hostname": {
539
+ "description": "Paperless-ngx base URL",
540
+ "env": "PPLS_HOSTNAME",
541
+ "helpGroup": "ENVIRONMENT",
542
+ "name": "hostname",
543
+ "hasDynamicHelp": false,
544
+ "multiple": false,
545
+ "type": "option"
546
+ },
547
+ "plain": {
548
+ "description": "Format output as plain text.",
549
+ "exclusive": [
550
+ "json",
551
+ "table"
552
+ ],
553
+ "helpGroup": "GLOBAL",
554
+ "name": "plain",
555
+ "allowNo": false,
556
+ "type": "boolean"
557
+ },
558
+ "table": {
559
+ "description": "Format output as table.",
560
+ "exclusive": [
561
+ "json",
562
+ "plain"
563
+ ],
564
+ "helpGroup": "GLOBAL",
565
+ "name": "table",
566
+ "allowNo": false,
567
+ "type": "boolean"
568
+ },
569
+ "token": {
570
+ "description": "Paperless-ngx API token",
571
+ "env": "PPLS_TOKEN",
572
+ "helpGroup": "ENVIRONMENT",
573
+ "name": "token",
574
+ "hasDynamicHelp": false,
575
+ "multiple": false,
576
+ "type": "option"
577
+ },
578
+ "page": {
579
+ "description": "Page number to fetch",
580
+ "name": "page",
581
+ "hasDynamicHelp": false,
582
+ "multiple": false,
583
+ "type": "option"
584
+ },
585
+ "page-size": {
586
+ "description": "Number of results per page",
587
+ "name": "page-size",
588
+ "hasDynamicHelp": false,
589
+ "multiple": false,
590
+ "type": "option"
591
+ },
592
+ "id-in": {
593
+ "description": "Filter by id list (comma-separated)",
594
+ "exclusive": [
595
+ "name-contains"
596
+ ],
597
+ "name": "id-in",
598
+ "hasDynamicHelp": false,
599
+ "multiple": false,
600
+ "type": "option"
601
+ },
602
+ "name-contains": {
603
+ "description": "Filter by name substring",
604
+ "exclusive": [
605
+ "id-in"
606
+ ],
607
+ "name": "name-contains",
608
+ "hasDynamicHelp": false,
609
+ "multiple": false,
610
+ "type": "option"
611
+ },
612
+ "sort": {
613
+ "description": "Sort results by the provided field",
614
+ "name": "sort",
615
+ "hasDynamicHelp": false,
616
+ "multiple": false,
617
+ "type": "option"
618
+ }
619
+ },
620
+ "hasDynamicHelp": false,
621
+ "hiddenAliases": [],
622
+ "id": "correspondents:list",
623
+ "pluginAlias": "@nickchristensen/ppls",
624
+ "pluginName": "@nickchristensen/ppls",
625
+ "pluginType": "core",
626
+ "strict": true,
627
+ "enableJsonFlag": true,
628
+ "isESM": true,
629
+ "relativePath": [
630
+ "dist",
631
+ "commands",
632
+ "correspondents",
633
+ "list.js"
634
+ ]
635
+ },
636
+ "correspondents:show": {
637
+ "aliases": [],
638
+ "args": {
639
+ "id": {
640
+ "description": "Correspondent id",
641
+ "name": "id",
642
+ "required": true
643
+ }
644
+ },
645
+ "description": "Show correspondent details",
646
+ "examples": [
647
+ "<%= config.bin %> <%= command.id %> 123"
648
+ ],
649
+ "flags": {
650
+ "json": {
651
+ "description": "Format output as json.",
652
+ "helpGroup": "GLOBAL",
653
+ "name": "json",
654
+ "allowNo": false,
655
+ "type": "boolean"
656
+ },
657
+ "date-format": {
658
+ "description": "Format output dates using a template.",
659
+ "env": "PPLS_DATE_FORMAT",
660
+ "helpGroup": "GLOBAL",
661
+ "name": "date-format",
662
+ "default": "yyyy-MM-dd",
663
+ "hasDynamicHelp": false,
664
+ "multiple": false,
665
+ "type": "option"
666
+ },
667
+ "header": {
668
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
669
+ "env": "PPLS_HEADERS",
670
+ "helpGroup": "ENVIRONMENT",
671
+ "name": "header",
672
+ "hasDynamicHelp": false,
673
+ "multiple": true,
674
+ "type": "option"
675
+ },
676
+ "hostname": {
677
+ "description": "Paperless-ngx base URL",
678
+ "env": "PPLS_HOSTNAME",
679
+ "helpGroup": "ENVIRONMENT",
680
+ "name": "hostname",
681
+ "hasDynamicHelp": false,
682
+ "multiple": false,
683
+ "type": "option"
684
+ },
685
+ "plain": {
686
+ "description": "Format output as plain text.",
687
+ "exclusive": [
688
+ "json",
689
+ "table"
690
+ ],
691
+ "helpGroup": "GLOBAL",
692
+ "name": "plain",
693
+ "allowNo": false,
694
+ "type": "boolean"
695
+ },
696
+ "table": {
697
+ "description": "Format output as table.",
698
+ "exclusive": [
699
+ "json",
700
+ "plain"
701
+ ],
702
+ "helpGroup": "GLOBAL",
703
+ "name": "table",
704
+ "allowNo": false,
705
+ "type": "boolean"
706
+ },
707
+ "token": {
708
+ "description": "Paperless-ngx API token",
709
+ "env": "PPLS_TOKEN",
710
+ "helpGroup": "ENVIRONMENT",
711
+ "name": "token",
712
+ "hasDynamicHelp": false,
713
+ "multiple": false,
714
+ "type": "option"
715
+ }
716
+ },
717
+ "hasDynamicHelp": false,
718
+ "hiddenAliases": [],
719
+ "id": "correspondents:show",
720
+ "pluginAlias": "@nickchristensen/ppls",
721
+ "pluginName": "@nickchristensen/ppls",
722
+ "pluginType": "core",
723
+ "strict": true,
724
+ "isESM": true,
725
+ "relativePath": [
726
+ "dist",
727
+ "commands",
728
+ "correspondents",
729
+ "show.js"
730
+ ]
731
+ },
732
+ "correspondents:update": {
733
+ "aliases": [],
734
+ "args": {
735
+ "id": {
736
+ "description": "Correspondent id",
737
+ "name": "id",
738
+ "required": true
739
+ }
740
+ },
741
+ "description": "Update a correspondent",
742
+ "examples": [
743
+ "<%= config.bin %> <%= command.id %> 123 --name \"Acme Corp\""
744
+ ],
745
+ "flags": {
746
+ "json": {
747
+ "description": "Format output as json.",
748
+ "helpGroup": "GLOBAL",
749
+ "name": "json",
750
+ "allowNo": false,
751
+ "type": "boolean"
752
+ },
753
+ "date-format": {
754
+ "description": "Format output dates using a template.",
755
+ "env": "PPLS_DATE_FORMAT",
756
+ "helpGroup": "GLOBAL",
757
+ "name": "date-format",
758
+ "default": "yyyy-MM-dd",
759
+ "hasDynamicHelp": false,
760
+ "multiple": false,
761
+ "type": "option"
762
+ },
763
+ "header": {
764
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
765
+ "env": "PPLS_HEADERS",
766
+ "helpGroup": "ENVIRONMENT",
767
+ "name": "header",
768
+ "hasDynamicHelp": false,
769
+ "multiple": true,
770
+ "type": "option"
771
+ },
772
+ "hostname": {
773
+ "description": "Paperless-ngx base URL",
774
+ "env": "PPLS_HOSTNAME",
775
+ "helpGroup": "ENVIRONMENT",
776
+ "name": "hostname",
777
+ "hasDynamicHelp": false,
778
+ "multiple": false,
779
+ "type": "option"
780
+ },
781
+ "plain": {
782
+ "description": "Format output as plain text.",
783
+ "exclusive": [
784
+ "json",
785
+ "table"
786
+ ],
787
+ "helpGroup": "GLOBAL",
788
+ "name": "plain",
789
+ "allowNo": false,
790
+ "type": "boolean"
791
+ },
792
+ "table": {
793
+ "description": "Format output as table.",
794
+ "exclusive": [
795
+ "json",
796
+ "plain"
797
+ ],
798
+ "helpGroup": "GLOBAL",
799
+ "name": "table",
800
+ "allowNo": false,
801
+ "type": "boolean"
802
+ },
803
+ "token": {
804
+ "description": "Paperless-ngx API token",
805
+ "env": "PPLS_TOKEN",
806
+ "helpGroup": "ENVIRONMENT",
807
+ "name": "token",
808
+ "hasDynamicHelp": false,
809
+ "multiple": false,
810
+ "type": "option"
811
+ },
812
+ "name": {
813
+ "description": "Correspondent name",
814
+ "name": "name",
815
+ "hasDynamicHelp": false,
816
+ "multiple": false,
817
+ "type": "option"
818
+ }
819
+ },
820
+ "hasDynamicHelp": false,
821
+ "hiddenAliases": [],
822
+ "id": "correspondents:update",
823
+ "pluginAlias": "@nickchristensen/ppls",
824
+ "pluginName": "@nickchristensen/ppls",
825
+ "pluginType": "core",
826
+ "strict": true,
827
+ "isESM": true,
828
+ "relativePath": [
829
+ "dist",
830
+ "commands",
831
+ "correspondents",
832
+ "update.js"
833
+ ]
834
+ },
835
+ "custom-fields:add": {
836
+ "aliases": [],
837
+ "args": {
838
+ "name": {
839
+ "description": "Custom field name",
840
+ "name": "name",
841
+ "required": true
842
+ }
843
+ },
844
+ "description": "Create a custom field",
845
+ "examples": [
846
+ "<%= config.bin %> <%= command.id %> \"Due Date\" --data-type date"
847
+ ],
848
+ "flags": {
849
+ "json": {
850
+ "description": "Format output as json.",
851
+ "helpGroup": "GLOBAL",
852
+ "name": "json",
853
+ "allowNo": false,
854
+ "type": "boolean"
855
+ },
856
+ "date-format": {
857
+ "description": "Format output dates using a template.",
858
+ "env": "PPLS_DATE_FORMAT",
859
+ "helpGroup": "GLOBAL",
860
+ "name": "date-format",
861
+ "default": "yyyy-MM-dd",
862
+ "hasDynamicHelp": false,
863
+ "multiple": false,
864
+ "type": "option"
865
+ },
866
+ "header": {
867
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
868
+ "env": "PPLS_HEADERS",
869
+ "helpGroup": "ENVIRONMENT",
870
+ "name": "header",
871
+ "hasDynamicHelp": false,
872
+ "multiple": true,
873
+ "type": "option"
874
+ },
875
+ "hostname": {
876
+ "description": "Paperless-ngx base URL",
877
+ "env": "PPLS_HOSTNAME",
878
+ "helpGroup": "ENVIRONMENT",
879
+ "name": "hostname",
880
+ "hasDynamicHelp": false,
881
+ "multiple": false,
882
+ "type": "option"
883
+ },
884
+ "plain": {
885
+ "description": "Format output as plain text.",
886
+ "exclusive": [
887
+ "json",
888
+ "table"
889
+ ],
890
+ "helpGroup": "GLOBAL",
891
+ "name": "plain",
892
+ "allowNo": false,
893
+ "type": "boolean"
894
+ },
895
+ "table": {
896
+ "description": "Format output as table.",
897
+ "exclusive": [
898
+ "json",
899
+ "plain"
900
+ ],
901
+ "helpGroup": "GLOBAL",
902
+ "name": "table",
903
+ "allowNo": false,
904
+ "type": "boolean"
905
+ },
906
+ "token": {
907
+ "description": "Paperless-ngx API token",
908
+ "env": "PPLS_TOKEN",
909
+ "helpGroup": "ENVIRONMENT",
910
+ "name": "token",
911
+ "hasDynamicHelp": false,
912
+ "multiple": false,
913
+ "type": "option"
914
+ },
915
+ "data-type": {
916
+ "description": "Custom field data type",
917
+ "name": "data-type",
918
+ "relationships": [
919
+ {
920
+ "flags": [
921
+ {
922
+ "name": "option"
923
+ }
924
+ ],
925
+ "type": "all"
926
+ }
927
+ ],
928
+ "required": true,
929
+ "hasDynamicHelp": false,
930
+ "multiple": false,
931
+ "options": [
932
+ "boolean",
933
+ "date",
934
+ "integer",
935
+ "number",
936
+ "monetary",
937
+ "text",
938
+ "url",
939
+ "document link",
940
+ "select",
941
+ "long text"
942
+ ],
943
+ "type": "option"
944
+ },
945
+ "option": {
946
+ "description": "Select option label (repeatable)",
947
+ "name": "option",
948
+ "relationships": [
949
+ {
950
+ "flags": [
951
+ {
952
+ "name": "data-type"
953
+ }
954
+ ],
955
+ "type": "none"
956
+ }
957
+ ],
958
+ "hasDynamicHelp": false,
959
+ "multiple": true,
960
+ "type": "option"
961
+ }
962
+ },
963
+ "hasDynamicHelp": false,
964
+ "hiddenAliases": [],
965
+ "id": "custom-fields:add",
966
+ "pluginAlias": "@nickchristensen/ppls",
967
+ "pluginName": "@nickchristensen/ppls",
968
+ "pluginType": "core",
969
+ "strict": true,
970
+ "isESM": true,
971
+ "relativePath": [
972
+ "dist",
973
+ "commands",
974
+ "custom-fields",
975
+ "add.js"
976
+ ]
977
+ },
978
+ "custom-fields:delete": {
979
+ "aliases": [],
980
+ "args": {
981
+ "id": {
982
+ "description": "Custom field id",
983
+ "name": "id",
984
+ "required": true
985
+ }
986
+ },
987
+ "description": "Delete a custom field",
988
+ "examples": [
989
+ "<%= config.bin %> <%= command.id %> 123"
990
+ ],
991
+ "flags": {
992
+ "json": {
993
+ "description": "Format output as json.",
994
+ "helpGroup": "GLOBAL",
995
+ "name": "json",
996
+ "allowNo": false,
997
+ "type": "boolean"
998
+ },
999
+ "date-format": {
1000
+ "description": "Format output dates using a template.",
1001
+ "env": "PPLS_DATE_FORMAT",
1002
+ "helpGroup": "GLOBAL",
1003
+ "name": "date-format",
1004
+ "default": "yyyy-MM-dd",
1005
+ "hasDynamicHelp": false,
1006
+ "multiple": false,
1007
+ "type": "option"
1008
+ },
1009
+ "header": {
1010
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
1011
+ "env": "PPLS_HEADERS",
1012
+ "helpGroup": "ENVIRONMENT",
1013
+ "name": "header",
1014
+ "hasDynamicHelp": false,
1015
+ "multiple": true,
1016
+ "type": "option"
1017
+ },
1018
+ "hostname": {
1019
+ "description": "Paperless-ngx base URL",
1020
+ "env": "PPLS_HOSTNAME",
1021
+ "helpGroup": "ENVIRONMENT",
1022
+ "name": "hostname",
1023
+ "hasDynamicHelp": false,
1024
+ "multiple": false,
1025
+ "type": "option"
1026
+ },
1027
+ "plain": {
1028
+ "description": "Format output as plain text.",
1029
+ "exclusive": [
1030
+ "json",
1031
+ "table"
1032
+ ],
1033
+ "helpGroup": "GLOBAL",
1034
+ "name": "plain",
1035
+ "allowNo": false,
1036
+ "type": "boolean"
1037
+ },
1038
+ "table": {
1039
+ "description": "Format output as table.",
1040
+ "exclusive": [
1041
+ "json",
1042
+ "plain"
1043
+ ],
1044
+ "helpGroup": "GLOBAL",
1045
+ "name": "table",
1046
+ "allowNo": false,
1047
+ "type": "boolean"
1048
+ },
1049
+ "token": {
1050
+ "description": "Paperless-ngx API token",
1051
+ "env": "PPLS_TOKEN",
1052
+ "helpGroup": "ENVIRONMENT",
1053
+ "name": "token",
1054
+ "hasDynamicHelp": false,
1055
+ "multiple": false,
1056
+ "type": "option"
1057
+ },
1058
+ "yes": {
1059
+ "char": "y",
1060
+ "description": "Skip confirmation prompt",
1061
+ "name": "yes",
1062
+ "allowNo": false,
1063
+ "type": "boolean"
1064
+ }
1065
+ },
1066
+ "hasDynamicHelp": false,
1067
+ "hiddenAliases": [],
1068
+ "id": "custom-fields:delete",
1069
+ "pluginAlias": "@nickchristensen/ppls",
1070
+ "pluginName": "@nickchristensen/ppls",
1071
+ "pluginType": "core",
1072
+ "strict": true,
1073
+ "isESM": true,
1074
+ "relativePath": [
1075
+ "dist",
1076
+ "commands",
1077
+ "custom-fields",
1078
+ "delete.js"
1079
+ ]
1080
+ },
1081
+ "custom-fields:list": {
1082
+ "aliases": [],
1083
+ "args": {},
1084
+ "description": "List custom fields",
1085
+ "examples": [
1086
+ "<%= config.bin %> <%= command.id %>"
1087
+ ],
1088
+ "flags": {
1089
+ "json": {
1090
+ "description": "Format output as json.",
1091
+ "helpGroup": "GLOBAL",
1092
+ "name": "json",
1093
+ "allowNo": false,
1094
+ "type": "boolean"
1095
+ },
1096
+ "date-format": {
1097
+ "description": "Format output dates using a template.",
1098
+ "env": "PPLS_DATE_FORMAT",
1099
+ "helpGroup": "GLOBAL",
1100
+ "name": "date-format",
1101
+ "default": "yyyy-MM-dd",
1102
+ "hasDynamicHelp": false,
1103
+ "multiple": false,
1104
+ "type": "option"
1105
+ },
1106
+ "header": {
1107
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
1108
+ "env": "PPLS_HEADERS",
1109
+ "helpGroup": "ENVIRONMENT",
1110
+ "name": "header",
1111
+ "hasDynamicHelp": false,
1112
+ "multiple": true,
1113
+ "type": "option"
1114
+ },
1115
+ "hostname": {
1116
+ "description": "Paperless-ngx base URL",
1117
+ "env": "PPLS_HOSTNAME",
1118
+ "helpGroup": "ENVIRONMENT",
1119
+ "name": "hostname",
1120
+ "hasDynamicHelp": false,
1121
+ "multiple": false,
1122
+ "type": "option"
1123
+ },
1124
+ "plain": {
1125
+ "description": "Format output as plain text.",
1126
+ "exclusive": [
1127
+ "json",
1128
+ "table"
1129
+ ],
1130
+ "helpGroup": "GLOBAL",
1131
+ "name": "plain",
1132
+ "allowNo": false,
1133
+ "type": "boolean"
1134
+ },
1135
+ "table": {
1136
+ "description": "Format output as table.",
1137
+ "exclusive": [
1138
+ "json",
1139
+ "plain"
1140
+ ],
1141
+ "helpGroup": "GLOBAL",
1142
+ "name": "table",
1143
+ "allowNo": false,
1144
+ "type": "boolean"
1145
+ },
1146
+ "token": {
1147
+ "description": "Paperless-ngx API token",
1148
+ "env": "PPLS_TOKEN",
1149
+ "helpGroup": "ENVIRONMENT",
1150
+ "name": "token",
1151
+ "hasDynamicHelp": false,
1152
+ "multiple": false,
1153
+ "type": "option"
1154
+ },
1155
+ "page": {
1156
+ "description": "Page number to fetch",
1157
+ "name": "page",
1158
+ "hasDynamicHelp": false,
1159
+ "multiple": false,
1160
+ "type": "option"
1161
+ },
1162
+ "page-size": {
1163
+ "description": "Number of results per page",
1164
+ "name": "page-size",
1165
+ "hasDynamicHelp": false,
1166
+ "multiple": false,
1167
+ "type": "option"
1168
+ },
1169
+ "id-in": {
1170
+ "description": "Filter by id list (comma-separated)",
1171
+ "exclusive": [
1172
+ "name-contains"
1173
+ ],
1174
+ "name": "id-in",
1175
+ "hasDynamicHelp": false,
1176
+ "multiple": false,
1177
+ "type": "option"
1178
+ },
1179
+ "name-contains": {
1180
+ "description": "Filter by name substring",
1181
+ "exclusive": [
1182
+ "id-in"
1183
+ ],
1184
+ "name": "name-contains",
1185
+ "hasDynamicHelp": false,
1186
+ "multiple": false,
1187
+ "type": "option"
1188
+ },
1189
+ "sort": {
1190
+ "description": "Sort results by the provided field",
1191
+ "name": "sort",
1192
+ "hasDynamicHelp": false,
1193
+ "multiple": false,
1194
+ "type": "option"
1195
+ }
1196
+ },
1197
+ "hasDynamicHelp": false,
1198
+ "hiddenAliases": [],
1199
+ "id": "custom-fields:list",
1200
+ "pluginAlias": "@nickchristensen/ppls",
1201
+ "pluginName": "@nickchristensen/ppls",
1202
+ "pluginType": "core",
1203
+ "strict": true,
1204
+ "enableJsonFlag": true,
1205
+ "isESM": true,
1206
+ "relativePath": [
1207
+ "dist",
1208
+ "commands",
1209
+ "custom-fields",
1210
+ "list.js"
1211
+ ]
1212
+ },
1213
+ "custom-fields:show": {
1214
+ "aliases": [],
1215
+ "args": {
1216
+ "id": {
1217
+ "description": "Custom field id",
1218
+ "name": "id",
1219
+ "required": true
1220
+ }
1221
+ },
1222
+ "description": "Show custom field details",
1223
+ "examples": [
1224
+ "<%= config.bin %> <%= command.id %> 123"
1225
+ ],
1226
+ "flags": {
1227
+ "json": {
1228
+ "description": "Format output as json.",
1229
+ "helpGroup": "GLOBAL",
1230
+ "name": "json",
1231
+ "allowNo": false,
1232
+ "type": "boolean"
1233
+ },
1234
+ "date-format": {
1235
+ "description": "Format output dates using a template.",
1236
+ "env": "PPLS_DATE_FORMAT",
1237
+ "helpGroup": "GLOBAL",
1238
+ "name": "date-format",
1239
+ "default": "yyyy-MM-dd",
1240
+ "hasDynamicHelp": false,
1241
+ "multiple": false,
1242
+ "type": "option"
1243
+ },
1244
+ "header": {
1245
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
1246
+ "env": "PPLS_HEADERS",
1247
+ "helpGroup": "ENVIRONMENT",
1248
+ "name": "header",
1249
+ "hasDynamicHelp": false,
1250
+ "multiple": true,
1251
+ "type": "option"
1252
+ },
1253
+ "hostname": {
1254
+ "description": "Paperless-ngx base URL",
1255
+ "env": "PPLS_HOSTNAME",
1256
+ "helpGroup": "ENVIRONMENT",
1257
+ "name": "hostname",
1258
+ "hasDynamicHelp": false,
1259
+ "multiple": false,
1260
+ "type": "option"
1261
+ },
1262
+ "plain": {
1263
+ "description": "Format output as plain text.",
1264
+ "exclusive": [
1265
+ "json",
1266
+ "table"
1267
+ ],
1268
+ "helpGroup": "GLOBAL",
1269
+ "name": "plain",
1270
+ "allowNo": false,
1271
+ "type": "boolean"
1272
+ },
1273
+ "table": {
1274
+ "description": "Format output as table.",
1275
+ "exclusive": [
1276
+ "json",
1277
+ "plain"
1278
+ ],
1279
+ "helpGroup": "GLOBAL",
1280
+ "name": "table",
1281
+ "allowNo": false,
1282
+ "type": "boolean"
1283
+ },
1284
+ "token": {
1285
+ "description": "Paperless-ngx API token",
1286
+ "env": "PPLS_TOKEN",
1287
+ "helpGroup": "ENVIRONMENT",
1288
+ "name": "token",
1289
+ "hasDynamicHelp": false,
1290
+ "multiple": false,
1291
+ "type": "option"
1292
+ }
1293
+ },
1294
+ "hasDynamicHelp": false,
1295
+ "hiddenAliases": [],
1296
+ "id": "custom-fields:show",
1297
+ "pluginAlias": "@nickchristensen/ppls",
1298
+ "pluginName": "@nickchristensen/ppls",
1299
+ "pluginType": "core",
1300
+ "strict": true,
1301
+ "isESM": true,
1302
+ "relativePath": [
1303
+ "dist",
1304
+ "commands",
1305
+ "custom-fields",
1306
+ "show.js"
1307
+ ]
1308
+ },
1309
+ "custom-fields:update": {
1310
+ "aliases": [],
1311
+ "args": {
1312
+ "id": {
1313
+ "description": "Custom field id",
1314
+ "name": "id",
1315
+ "required": true
1316
+ }
1317
+ },
1318
+ "description": "Update a custom field",
1319
+ "examples": [
1320
+ "<%= config.bin %> <%= command.id %> 123 --name \"Due Date\""
1321
+ ],
1322
+ "flags": {
1323
+ "json": {
1324
+ "description": "Format output as json.",
1325
+ "helpGroup": "GLOBAL",
1326
+ "name": "json",
1327
+ "allowNo": false,
1328
+ "type": "boolean"
1329
+ },
1330
+ "date-format": {
1331
+ "description": "Format output dates using a template.",
1332
+ "env": "PPLS_DATE_FORMAT",
1333
+ "helpGroup": "GLOBAL",
1334
+ "name": "date-format",
1335
+ "default": "yyyy-MM-dd",
1336
+ "hasDynamicHelp": false,
1337
+ "multiple": false,
1338
+ "type": "option"
1339
+ },
1340
+ "header": {
1341
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
1342
+ "env": "PPLS_HEADERS",
1343
+ "helpGroup": "ENVIRONMENT",
1344
+ "name": "header",
1345
+ "hasDynamicHelp": false,
1346
+ "multiple": true,
1347
+ "type": "option"
1348
+ },
1349
+ "hostname": {
1350
+ "description": "Paperless-ngx base URL",
1351
+ "env": "PPLS_HOSTNAME",
1352
+ "helpGroup": "ENVIRONMENT",
1353
+ "name": "hostname",
1354
+ "hasDynamicHelp": false,
1355
+ "multiple": false,
1356
+ "type": "option"
1357
+ },
1358
+ "plain": {
1359
+ "description": "Format output as plain text.",
1360
+ "exclusive": [
1361
+ "json",
1362
+ "table"
1363
+ ],
1364
+ "helpGroup": "GLOBAL",
1365
+ "name": "plain",
1366
+ "allowNo": false,
1367
+ "type": "boolean"
1368
+ },
1369
+ "table": {
1370
+ "description": "Format output as table.",
1371
+ "exclusive": [
1372
+ "json",
1373
+ "plain"
1374
+ ],
1375
+ "helpGroup": "GLOBAL",
1376
+ "name": "table",
1377
+ "allowNo": false,
1378
+ "type": "boolean"
1379
+ },
1380
+ "token": {
1381
+ "description": "Paperless-ngx API token",
1382
+ "env": "PPLS_TOKEN",
1383
+ "helpGroup": "ENVIRONMENT",
1384
+ "name": "token",
1385
+ "hasDynamicHelp": false,
1386
+ "multiple": false,
1387
+ "type": "option"
1388
+ },
1389
+ "data-type": {
1390
+ "description": "Custom field data type",
1391
+ "name": "data-type",
1392
+ "relationships": [
1393
+ {
1394
+ "flags": [
1395
+ {
1396
+ "name": "option"
1397
+ }
1398
+ ],
1399
+ "type": "all"
1400
+ }
1401
+ ],
1402
+ "hasDynamicHelp": false,
1403
+ "multiple": false,
1404
+ "options": [
1405
+ "boolean",
1406
+ "date",
1407
+ "integer",
1408
+ "number",
1409
+ "monetary",
1410
+ "text",
1411
+ "url",
1412
+ "document link",
1413
+ "select",
1414
+ "long text"
1415
+ ],
1416
+ "type": "option"
1417
+ },
1418
+ "name": {
1419
+ "description": "Custom field name",
1420
+ "name": "name",
1421
+ "hasDynamicHelp": false,
1422
+ "multiple": false,
1423
+ "type": "option"
1424
+ },
1425
+ "option": {
1426
+ "description": "Select option label (repeatable)",
1427
+ "name": "option",
1428
+ "relationships": [
1429
+ {
1430
+ "flags": [
1431
+ {
1432
+ "name": "data-type"
1433
+ }
1434
+ ],
1435
+ "type": "none"
1436
+ }
1437
+ ],
1438
+ "hasDynamicHelp": false,
1439
+ "multiple": true,
1440
+ "type": "option"
1441
+ }
1442
+ },
1443
+ "hasDynamicHelp": false,
1444
+ "hiddenAliases": [],
1445
+ "id": "custom-fields:update",
1446
+ "pluginAlias": "@nickchristensen/ppls",
1447
+ "pluginName": "@nickchristensen/ppls",
1448
+ "pluginType": "core",
1449
+ "strict": true,
1450
+ "isESM": true,
1451
+ "relativePath": [
1452
+ "dist",
1453
+ "commands",
1454
+ "custom-fields",
1455
+ "update.js"
1456
+ ]
1457
+ },
1458
+ "documents:add": {
1459
+ "aliases": [],
1460
+ "args": {
1461
+ "path": {
1462
+ "description": "Document file path(s)",
1463
+ "name": "path"
1464
+ }
1465
+ },
1466
+ "description": "Upload one or more documents. Supports multiple arguments or a glob.",
1467
+ "examples": [
1468
+ "<%= config.bin %> <%= command.id %> ./receipt.pdf --title \"Receipt\""
1469
+ ],
1470
+ "flags": {
1471
+ "json": {
1472
+ "description": "Format output as json.",
1473
+ "helpGroup": "GLOBAL",
1474
+ "name": "json",
1475
+ "allowNo": false,
1476
+ "type": "boolean"
1477
+ },
1478
+ "date-format": {
1479
+ "description": "Format output dates using a template.",
1480
+ "env": "PPLS_DATE_FORMAT",
1481
+ "helpGroup": "GLOBAL",
1482
+ "name": "date-format",
1483
+ "default": "yyyy-MM-dd",
1484
+ "hasDynamicHelp": false,
1485
+ "multiple": false,
1486
+ "type": "option"
1487
+ },
1488
+ "header": {
1489
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
1490
+ "env": "PPLS_HEADERS",
1491
+ "helpGroup": "ENVIRONMENT",
1492
+ "name": "header",
1493
+ "hasDynamicHelp": false,
1494
+ "multiple": true,
1495
+ "type": "option"
1496
+ },
1497
+ "hostname": {
1498
+ "description": "Paperless-ngx base URL",
1499
+ "env": "PPLS_HOSTNAME",
1500
+ "helpGroup": "ENVIRONMENT",
1501
+ "name": "hostname",
1502
+ "hasDynamicHelp": false,
1503
+ "multiple": false,
1504
+ "type": "option"
1505
+ },
1506
+ "plain": {
1507
+ "description": "Format output as plain text.",
1508
+ "exclusive": [
1509
+ "json",
1510
+ "table"
1511
+ ],
1512
+ "helpGroup": "GLOBAL",
1513
+ "name": "plain",
1514
+ "allowNo": false,
1515
+ "type": "boolean"
1516
+ },
1517
+ "table": {
1518
+ "description": "Format output as table.",
1519
+ "exclusive": [
1520
+ "json",
1521
+ "plain"
1522
+ ],
1523
+ "helpGroup": "GLOBAL",
1524
+ "name": "table",
1525
+ "allowNo": false,
1526
+ "type": "boolean"
1527
+ },
1528
+ "token": {
1529
+ "description": "Paperless-ngx API token",
1530
+ "env": "PPLS_TOKEN",
1531
+ "helpGroup": "ENVIRONMENT",
1532
+ "name": "token",
1533
+ "hasDynamicHelp": false,
1534
+ "multiple": false,
1535
+ "type": "option"
1536
+ },
1537
+ "archive-serial-number": {
1538
+ "description": "Archive serial number",
1539
+ "name": "archive-serial-number",
1540
+ "hasDynamicHelp": false,
1541
+ "multiple": false,
1542
+ "type": "option"
1543
+ },
1544
+ "correspondent": {
1545
+ "description": "Correspondent id",
1546
+ "name": "correspondent",
1547
+ "hasDynamicHelp": false,
1548
+ "multiple": false,
1549
+ "type": "option"
1550
+ },
1551
+ "created": {
1552
+ "description": "Document created date-time",
1553
+ "name": "created",
1554
+ "hasDynamicHelp": false,
1555
+ "multiple": false,
1556
+ "type": "option"
1557
+ },
1558
+ "document-type": {
1559
+ "description": "Document type id",
1560
+ "name": "document-type",
1561
+ "hasDynamicHelp": false,
1562
+ "multiple": false,
1563
+ "type": "option"
1564
+ },
1565
+ "storage-path": {
1566
+ "description": "Storage path id",
1567
+ "name": "storage-path",
1568
+ "hasDynamicHelp": false,
1569
+ "multiple": false,
1570
+ "type": "option"
1571
+ },
1572
+ "tag": {
1573
+ "description": "Tag id (repeatable)",
1574
+ "name": "tag",
1575
+ "hasDynamicHelp": false,
1576
+ "multiple": true,
1577
+ "type": "option"
1578
+ },
1579
+ "title": {
1580
+ "description": "Document title",
1581
+ "name": "title",
1582
+ "hasDynamicHelp": false,
1583
+ "multiple": false,
1584
+ "type": "option"
1585
+ }
1586
+ },
1587
+ "hasDynamicHelp": false,
1588
+ "hiddenAliases": [],
1589
+ "id": "documents:add",
1590
+ "pluginAlias": "@nickchristensen/ppls",
1591
+ "pluginName": "@nickchristensen/ppls",
1592
+ "pluginType": "core",
1593
+ "strict": false,
1594
+ "enableJsonFlag": true,
1595
+ "isESM": true,
1596
+ "relativePath": [
1597
+ "dist",
1598
+ "commands",
1599
+ "documents",
1600
+ "add.js"
1601
+ ]
1602
+ },
1603
+ "documents:delete": {
1604
+ "aliases": [],
1605
+ "args": {
1606
+ "id": {
1607
+ "description": "Document id",
1608
+ "name": "id",
1609
+ "required": true
1610
+ }
1611
+ },
1612
+ "description": "Delete a document",
1613
+ "examples": [
1614
+ "<%= config.bin %> <%= command.id %> 123"
1615
+ ],
1616
+ "flags": {
1617
+ "json": {
1618
+ "description": "Format output as json.",
1619
+ "helpGroup": "GLOBAL",
1620
+ "name": "json",
1621
+ "allowNo": false,
1622
+ "type": "boolean"
1623
+ },
1624
+ "date-format": {
1625
+ "description": "Format output dates using a template.",
1626
+ "env": "PPLS_DATE_FORMAT",
1627
+ "helpGroup": "GLOBAL",
1628
+ "name": "date-format",
1629
+ "default": "yyyy-MM-dd",
1630
+ "hasDynamicHelp": false,
1631
+ "multiple": false,
1632
+ "type": "option"
1633
+ },
1634
+ "header": {
1635
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
1636
+ "env": "PPLS_HEADERS",
1637
+ "helpGroup": "ENVIRONMENT",
1638
+ "name": "header",
1639
+ "hasDynamicHelp": false,
1640
+ "multiple": true,
1641
+ "type": "option"
1642
+ },
1643
+ "hostname": {
1644
+ "description": "Paperless-ngx base URL",
1645
+ "env": "PPLS_HOSTNAME",
1646
+ "helpGroup": "ENVIRONMENT",
1647
+ "name": "hostname",
1648
+ "hasDynamicHelp": false,
1649
+ "multiple": false,
1650
+ "type": "option"
1651
+ },
1652
+ "plain": {
1653
+ "description": "Format output as plain text.",
1654
+ "exclusive": [
1655
+ "json",
1656
+ "table"
1657
+ ],
1658
+ "helpGroup": "GLOBAL",
1659
+ "name": "plain",
1660
+ "allowNo": false,
1661
+ "type": "boolean"
1662
+ },
1663
+ "table": {
1664
+ "description": "Format output as table.",
1665
+ "exclusive": [
1666
+ "json",
1667
+ "plain"
1668
+ ],
1669
+ "helpGroup": "GLOBAL",
1670
+ "name": "table",
1671
+ "allowNo": false,
1672
+ "type": "boolean"
1673
+ },
1674
+ "token": {
1675
+ "description": "Paperless-ngx API token",
1676
+ "env": "PPLS_TOKEN",
1677
+ "helpGroup": "ENVIRONMENT",
1678
+ "name": "token",
1679
+ "hasDynamicHelp": false,
1680
+ "multiple": false,
1681
+ "type": "option"
1682
+ },
1683
+ "yes": {
1684
+ "char": "y",
1685
+ "description": "Skip confirmation prompt",
1686
+ "name": "yes",
1687
+ "allowNo": false,
1688
+ "type": "boolean"
1689
+ }
1690
+ },
1691
+ "hasDynamicHelp": false,
1692
+ "hiddenAliases": [],
1693
+ "id": "documents:delete",
1694
+ "pluginAlias": "@nickchristensen/ppls",
1695
+ "pluginName": "@nickchristensen/ppls",
1696
+ "pluginType": "core",
1697
+ "strict": true,
1698
+ "isESM": true,
1699
+ "relativePath": [
1700
+ "dist",
1701
+ "commands",
1702
+ "documents",
1703
+ "delete.js"
1704
+ ]
1705
+ },
1706
+ "documents:download": {
1707
+ "aliases": [],
1708
+ "args": {
1709
+ "id": {
1710
+ "description": "Document id or comma-separated list of ids",
1711
+ "name": "id",
1712
+ "required": true
1713
+ }
1714
+ },
1715
+ "description": "Download one or more documents",
1716
+ "examples": [
1717
+ "<%= config.bin %> <%= command.id %> 123 --output document.pdf",
1718
+ "<%= config.bin %> <%= command.id %> 123,124 --output-dir ./downloads"
1719
+ ],
1720
+ "flags": {
1721
+ "json": {
1722
+ "description": "Format output as json.",
1723
+ "helpGroup": "GLOBAL",
1724
+ "name": "json",
1725
+ "allowNo": false,
1726
+ "type": "boolean"
1727
+ },
1728
+ "date-format": {
1729
+ "description": "Format output dates using a template.",
1730
+ "env": "PPLS_DATE_FORMAT",
1731
+ "helpGroup": "GLOBAL",
1732
+ "name": "date-format",
1733
+ "default": "yyyy-MM-dd",
1734
+ "hasDynamicHelp": false,
1735
+ "multiple": false,
1736
+ "type": "option"
1737
+ },
1738
+ "header": {
1739
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
1740
+ "env": "PPLS_HEADERS",
1741
+ "helpGroup": "ENVIRONMENT",
1742
+ "name": "header",
1743
+ "hasDynamicHelp": false,
1744
+ "multiple": true,
1745
+ "type": "option"
1746
+ },
1747
+ "hostname": {
1748
+ "description": "Paperless-ngx base URL",
1749
+ "env": "PPLS_HOSTNAME",
1750
+ "helpGroup": "ENVIRONMENT",
1751
+ "name": "hostname",
1752
+ "hasDynamicHelp": false,
1753
+ "multiple": false,
1754
+ "type": "option"
1755
+ },
1756
+ "plain": {
1757
+ "description": "Format output as plain text.",
1758
+ "exclusive": [
1759
+ "json",
1760
+ "table"
1761
+ ],
1762
+ "helpGroup": "GLOBAL",
1763
+ "name": "plain",
1764
+ "allowNo": false,
1765
+ "type": "boolean"
1766
+ },
1767
+ "table": {
1768
+ "description": "Format output as table.",
1769
+ "exclusive": [
1770
+ "json",
1771
+ "plain"
1772
+ ],
1773
+ "helpGroup": "GLOBAL",
1774
+ "name": "table",
1775
+ "allowNo": false,
1776
+ "type": "boolean"
1777
+ },
1778
+ "token": {
1779
+ "description": "Paperless-ngx API token",
1780
+ "env": "PPLS_TOKEN",
1781
+ "helpGroup": "ENVIRONMENT",
1782
+ "name": "token",
1783
+ "hasDynamicHelp": false,
1784
+ "multiple": false,
1785
+ "type": "option"
1786
+ },
1787
+ "original": {
1788
+ "description": "Download original file",
1789
+ "name": "original",
1790
+ "allowNo": false,
1791
+ "type": "boolean"
1792
+ },
1793
+ "output": {
1794
+ "char": "o",
1795
+ "description": "Output file path (single document)",
1796
+ "exclusive": [
1797
+ "output-dir"
1798
+ ],
1799
+ "name": "output",
1800
+ "hasDynamicHelp": false,
1801
+ "multiple": false,
1802
+ "type": "option"
1803
+ },
1804
+ "output-dir": {
1805
+ "description": "Output directory (multiple documents)",
1806
+ "exclusive": [
1807
+ "output"
1808
+ ],
1809
+ "name": "output-dir",
1810
+ "hasDynamicHelp": false,
1811
+ "multiple": false,
1812
+ "type": "option"
1813
+ }
1814
+ },
1815
+ "hasDynamicHelp": false,
1816
+ "hiddenAliases": [],
1817
+ "id": "documents:download",
1818
+ "pluginAlias": "@nickchristensen/ppls",
1819
+ "pluginName": "@nickchristensen/ppls",
1820
+ "pluginType": "core",
1821
+ "strict": true,
1822
+ "enableJsonFlag": true,
1823
+ "isESM": true,
1824
+ "relativePath": [
1825
+ "dist",
1826
+ "commands",
1827
+ "documents",
1828
+ "download.js"
1829
+ ]
1830
+ },
1831
+ "documents:list": {
1832
+ "aliases": [],
1833
+ "args": {},
1834
+ "description": "List documents",
1835
+ "examples": [
1836
+ "<%= config.bin %> <%= command.id %>"
1837
+ ],
1838
+ "flags": {
1839
+ "json": {
1840
+ "description": "Format output as json.",
1841
+ "helpGroup": "GLOBAL",
1842
+ "name": "json",
1843
+ "allowNo": false,
1844
+ "type": "boolean"
1845
+ },
1846
+ "date-format": {
1847
+ "description": "Format output dates using a template.",
1848
+ "env": "PPLS_DATE_FORMAT",
1849
+ "helpGroup": "GLOBAL",
1850
+ "name": "date-format",
1851
+ "default": "yyyy-MM-dd",
1852
+ "hasDynamicHelp": false,
1853
+ "multiple": false,
1854
+ "type": "option"
1855
+ },
1856
+ "header": {
1857
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
1858
+ "env": "PPLS_HEADERS",
1859
+ "helpGroup": "ENVIRONMENT",
1860
+ "name": "header",
1861
+ "hasDynamicHelp": false,
1862
+ "multiple": true,
1863
+ "type": "option"
1864
+ },
1865
+ "hostname": {
1866
+ "description": "Paperless-ngx base URL",
1867
+ "env": "PPLS_HOSTNAME",
1868
+ "helpGroup": "ENVIRONMENT",
1869
+ "name": "hostname",
1870
+ "hasDynamicHelp": false,
1871
+ "multiple": false,
1872
+ "type": "option"
1873
+ },
1874
+ "plain": {
1875
+ "description": "Format output as plain text.",
1876
+ "exclusive": [
1877
+ "json",
1878
+ "table"
1879
+ ],
1880
+ "helpGroup": "GLOBAL",
1881
+ "name": "plain",
1882
+ "allowNo": false,
1883
+ "type": "boolean"
1884
+ },
1885
+ "table": {
1886
+ "description": "Format output as table.",
1887
+ "exclusive": [
1888
+ "json",
1889
+ "plain"
1890
+ ],
1891
+ "helpGroup": "GLOBAL",
1892
+ "name": "table",
1893
+ "allowNo": false,
1894
+ "type": "boolean"
1895
+ },
1896
+ "token": {
1897
+ "description": "Paperless-ngx API token",
1898
+ "env": "PPLS_TOKEN",
1899
+ "helpGroup": "ENVIRONMENT",
1900
+ "name": "token",
1901
+ "hasDynamicHelp": false,
1902
+ "multiple": false,
1903
+ "type": "option"
1904
+ },
1905
+ "page": {
1906
+ "description": "Page number to fetch",
1907
+ "name": "page",
1908
+ "hasDynamicHelp": false,
1909
+ "multiple": false,
1910
+ "type": "option"
1911
+ },
1912
+ "page-size": {
1913
+ "description": "Number of results per page",
1914
+ "name": "page-size",
1915
+ "hasDynamicHelp": false,
1916
+ "multiple": false,
1917
+ "type": "option"
1918
+ },
1919
+ "id-in": {
1920
+ "description": "Filter by id list (comma-separated)",
1921
+ "exclusive": [
1922
+ "name-contains"
1923
+ ],
1924
+ "name": "id-in",
1925
+ "hasDynamicHelp": false,
1926
+ "multiple": false,
1927
+ "type": "option"
1928
+ },
1929
+ "name-contains": {
1930
+ "description": "Filter by name substring",
1931
+ "exclusive": [
1932
+ "id-in"
1933
+ ],
1934
+ "name": "name-contains",
1935
+ "hasDynamicHelp": false,
1936
+ "multiple": false,
1937
+ "type": "option"
1938
+ },
1939
+ "sort": {
1940
+ "description": "Sort results by the provided field",
1941
+ "name": "sort",
1942
+ "hasDynamicHelp": false,
1943
+ "multiple": false,
1944
+ "type": "option"
1945
+ }
1946
+ },
1947
+ "hasDynamicHelp": false,
1948
+ "hiddenAliases": [],
1949
+ "id": "documents:list",
1950
+ "pluginAlias": "@nickchristensen/ppls",
1951
+ "pluginName": "@nickchristensen/ppls",
1952
+ "pluginType": "core",
1953
+ "strict": true,
1954
+ "enableJsonFlag": true,
1955
+ "isESM": true,
1956
+ "relativePath": [
1957
+ "dist",
1958
+ "commands",
1959
+ "documents",
1960
+ "list.js"
1961
+ ]
1962
+ },
1963
+ "documents:show": {
1964
+ "aliases": [],
1965
+ "args": {
1966
+ "id": {
1967
+ "description": "Document id",
1968
+ "name": "id",
1969
+ "required": true
1970
+ }
1971
+ },
1972
+ "description": "Show document details",
1973
+ "examples": [
1974
+ "<%= config.bin %> <%= command.id %> 123"
1975
+ ],
1976
+ "flags": {
1977
+ "json": {
1978
+ "description": "Format output as json.",
1979
+ "helpGroup": "GLOBAL",
1980
+ "name": "json",
1981
+ "allowNo": false,
1982
+ "type": "boolean"
1983
+ },
1984
+ "date-format": {
1985
+ "description": "Format output dates using a template.",
1986
+ "env": "PPLS_DATE_FORMAT",
1987
+ "helpGroup": "GLOBAL",
1988
+ "name": "date-format",
1989
+ "default": "yyyy-MM-dd",
1990
+ "hasDynamicHelp": false,
1991
+ "multiple": false,
1992
+ "type": "option"
1993
+ },
1994
+ "header": {
1995
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
1996
+ "env": "PPLS_HEADERS",
1997
+ "helpGroup": "ENVIRONMENT",
1998
+ "name": "header",
1999
+ "hasDynamicHelp": false,
2000
+ "multiple": true,
2001
+ "type": "option"
2002
+ },
2003
+ "hostname": {
2004
+ "description": "Paperless-ngx base URL",
2005
+ "env": "PPLS_HOSTNAME",
2006
+ "helpGroup": "ENVIRONMENT",
2007
+ "name": "hostname",
2008
+ "hasDynamicHelp": false,
2009
+ "multiple": false,
2010
+ "type": "option"
2011
+ },
2012
+ "plain": {
2013
+ "description": "Format output as plain text.",
2014
+ "exclusive": [
2015
+ "json",
2016
+ "table"
2017
+ ],
2018
+ "helpGroup": "GLOBAL",
2019
+ "name": "plain",
2020
+ "allowNo": false,
2021
+ "type": "boolean"
2022
+ },
2023
+ "table": {
2024
+ "description": "Format output as table.",
2025
+ "exclusive": [
2026
+ "json",
2027
+ "plain"
2028
+ ],
2029
+ "helpGroup": "GLOBAL",
2030
+ "name": "table",
2031
+ "allowNo": false,
2032
+ "type": "boolean"
2033
+ },
2034
+ "token": {
2035
+ "description": "Paperless-ngx API token",
2036
+ "env": "PPLS_TOKEN",
2037
+ "helpGroup": "ENVIRONMENT",
2038
+ "name": "token",
2039
+ "hasDynamicHelp": false,
2040
+ "multiple": false,
2041
+ "type": "option"
2042
+ }
2043
+ },
2044
+ "hasDynamicHelp": false,
2045
+ "hiddenAliases": [],
2046
+ "id": "documents:show",
2047
+ "pluginAlias": "@nickchristensen/ppls",
2048
+ "pluginName": "@nickchristensen/ppls",
2049
+ "pluginType": "core",
2050
+ "strict": true,
2051
+ "isESM": true,
2052
+ "relativePath": [
2053
+ "dist",
2054
+ "commands",
2055
+ "documents",
2056
+ "show.js"
2057
+ ]
2058
+ },
2059
+ "documents:update": {
2060
+ "aliases": [],
2061
+ "args": {
2062
+ "id": {
2063
+ "description": "Document id",
2064
+ "name": "id",
2065
+ "required": true
2066
+ }
2067
+ },
2068
+ "description": "Update a document",
2069
+ "examples": [
2070
+ "<%= config.bin %> <%= command.id %> 123 --title \"Receipt\""
2071
+ ],
2072
+ "flags": {
2073
+ "json": {
2074
+ "description": "Format output as json.",
2075
+ "helpGroup": "GLOBAL",
2076
+ "name": "json",
2077
+ "allowNo": false,
2078
+ "type": "boolean"
2079
+ },
2080
+ "date-format": {
2081
+ "description": "Format output dates using a template.",
2082
+ "env": "PPLS_DATE_FORMAT",
2083
+ "helpGroup": "GLOBAL",
2084
+ "name": "date-format",
2085
+ "default": "yyyy-MM-dd",
2086
+ "hasDynamicHelp": false,
2087
+ "multiple": false,
2088
+ "type": "option"
2089
+ },
2090
+ "header": {
2091
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
2092
+ "env": "PPLS_HEADERS",
2093
+ "helpGroup": "ENVIRONMENT",
2094
+ "name": "header",
2095
+ "hasDynamicHelp": false,
2096
+ "multiple": true,
2097
+ "type": "option"
2098
+ },
2099
+ "hostname": {
2100
+ "description": "Paperless-ngx base URL",
2101
+ "env": "PPLS_HOSTNAME",
2102
+ "helpGroup": "ENVIRONMENT",
2103
+ "name": "hostname",
2104
+ "hasDynamicHelp": false,
2105
+ "multiple": false,
2106
+ "type": "option"
2107
+ },
2108
+ "plain": {
2109
+ "description": "Format output as plain text.",
2110
+ "exclusive": [
2111
+ "json",
2112
+ "table"
2113
+ ],
2114
+ "helpGroup": "GLOBAL",
2115
+ "name": "plain",
2116
+ "allowNo": false,
2117
+ "type": "boolean"
2118
+ },
2119
+ "table": {
2120
+ "description": "Format output as table.",
2121
+ "exclusive": [
2122
+ "json",
2123
+ "plain"
2124
+ ],
2125
+ "helpGroup": "GLOBAL",
2126
+ "name": "table",
2127
+ "allowNo": false,
2128
+ "type": "boolean"
2129
+ },
2130
+ "token": {
2131
+ "description": "Paperless-ngx API token",
2132
+ "env": "PPLS_TOKEN",
2133
+ "helpGroup": "ENVIRONMENT",
2134
+ "name": "token",
2135
+ "hasDynamicHelp": false,
2136
+ "multiple": false,
2137
+ "type": "option"
2138
+ },
2139
+ "archive-serial-number": {
2140
+ "description": "Archive serial number",
2141
+ "name": "archive-serial-number",
2142
+ "hasDynamicHelp": false,
2143
+ "multiple": false,
2144
+ "type": "option"
2145
+ },
2146
+ "content": {
2147
+ "description": "Document content",
2148
+ "name": "content",
2149
+ "hasDynamicHelp": false,
2150
+ "multiple": false,
2151
+ "type": "option"
2152
+ },
2153
+ "correspondent": {
2154
+ "description": "Correspondent id",
2155
+ "name": "correspondent",
2156
+ "hasDynamicHelp": false,
2157
+ "multiple": false,
2158
+ "type": "option"
2159
+ },
2160
+ "created": {
2161
+ "description": "Document created date",
2162
+ "name": "created",
2163
+ "hasDynamicHelp": false,
2164
+ "multiple": false,
2165
+ "type": "option"
2166
+ },
2167
+ "document-type": {
2168
+ "description": "Document type id",
2169
+ "name": "document-type",
2170
+ "hasDynamicHelp": false,
2171
+ "multiple": false,
2172
+ "type": "option"
2173
+ },
2174
+ "storage-path": {
2175
+ "description": "Storage path id",
2176
+ "name": "storage-path",
2177
+ "hasDynamicHelp": false,
2178
+ "multiple": false,
2179
+ "type": "option"
2180
+ },
2181
+ "tag": {
2182
+ "description": "Tag id (repeatable)",
2183
+ "name": "tag",
2184
+ "hasDynamicHelp": false,
2185
+ "multiple": true,
2186
+ "type": "option"
2187
+ },
2188
+ "title": {
2189
+ "description": "Document title",
2190
+ "name": "title",
2191
+ "hasDynamicHelp": false,
2192
+ "multiple": false,
2193
+ "type": "option"
2194
+ }
2195
+ },
2196
+ "hasDynamicHelp": false,
2197
+ "hiddenAliases": [],
2198
+ "id": "documents:update",
2199
+ "pluginAlias": "@nickchristensen/ppls",
2200
+ "pluginName": "@nickchristensen/ppls",
2201
+ "pluginType": "core",
2202
+ "strict": true,
2203
+ "isESM": true,
2204
+ "relativePath": [
2205
+ "dist",
2206
+ "commands",
2207
+ "documents",
2208
+ "update.js"
2209
+ ]
2210
+ },
2211
+ "document-types:add": {
2212
+ "aliases": [],
2213
+ "args": {
2214
+ "name": {
2215
+ "description": "Document type name",
2216
+ "name": "name",
2217
+ "required": true
2218
+ }
2219
+ },
2220
+ "description": "Create a document type",
2221
+ "examples": [
2222
+ "<%= config.bin %> <%= command.id %> \"Invoice\""
2223
+ ],
2224
+ "flags": {
2225
+ "json": {
2226
+ "description": "Format output as json.",
2227
+ "helpGroup": "GLOBAL",
2228
+ "name": "json",
2229
+ "allowNo": false,
2230
+ "type": "boolean"
2231
+ },
2232
+ "date-format": {
2233
+ "description": "Format output dates using a template.",
2234
+ "env": "PPLS_DATE_FORMAT",
2235
+ "helpGroup": "GLOBAL",
2236
+ "name": "date-format",
2237
+ "default": "yyyy-MM-dd",
2238
+ "hasDynamicHelp": false,
2239
+ "multiple": false,
2240
+ "type": "option"
2241
+ },
2242
+ "header": {
2243
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
2244
+ "env": "PPLS_HEADERS",
2245
+ "helpGroup": "ENVIRONMENT",
2246
+ "name": "header",
2247
+ "hasDynamicHelp": false,
2248
+ "multiple": true,
2249
+ "type": "option"
2250
+ },
2251
+ "hostname": {
2252
+ "description": "Paperless-ngx base URL",
2253
+ "env": "PPLS_HOSTNAME",
2254
+ "helpGroup": "ENVIRONMENT",
2255
+ "name": "hostname",
2256
+ "hasDynamicHelp": false,
2257
+ "multiple": false,
2258
+ "type": "option"
2259
+ },
2260
+ "plain": {
2261
+ "description": "Format output as plain text.",
2262
+ "exclusive": [
2263
+ "json",
2264
+ "table"
2265
+ ],
2266
+ "helpGroup": "GLOBAL",
2267
+ "name": "plain",
2268
+ "allowNo": false,
2269
+ "type": "boolean"
2270
+ },
2271
+ "table": {
2272
+ "description": "Format output as table.",
2273
+ "exclusive": [
2274
+ "json",
2275
+ "plain"
2276
+ ],
2277
+ "helpGroup": "GLOBAL",
2278
+ "name": "table",
2279
+ "allowNo": false,
2280
+ "type": "boolean"
2281
+ },
2282
+ "token": {
2283
+ "description": "Paperless-ngx API token",
2284
+ "env": "PPLS_TOKEN",
2285
+ "helpGroup": "ENVIRONMENT",
2286
+ "name": "token",
2287
+ "hasDynamicHelp": false,
2288
+ "multiple": false,
2289
+ "type": "option"
2290
+ }
2291
+ },
2292
+ "hasDynamicHelp": false,
2293
+ "hiddenAliases": [],
2294
+ "id": "document-types:add",
2295
+ "pluginAlias": "@nickchristensen/ppls",
2296
+ "pluginName": "@nickchristensen/ppls",
2297
+ "pluginType": "core",
2298
+ "strict": true,
2299
+ "isESM": true,
2300
+ "relativePath": [
2301
+ "dist",
2302
+ "commands",
2303
+ "document-types",
2304
+ "add.js"
2305
+ ]
2306
+ },
2307
+ "document-types:delete": {
2308
+ "aliases": [],
2309
+ "args": {
2310
+ "id": {
2311
+ "description": "Document type id",
2312
+ "name": "id",
2313
+ "required": true
2314
+ }
2315
+ },
2316
+ "description": "Delete a document type",
2317
+ "examples": [
2318
+ "<%= config.bin %> <%= command.id %> 123"
2319
+ ],
2320
+ "flags": {
2321
+ "json": {
2322
+ "description": "Format output as json.",
2323
+ "helpGroup": "GLOBAL",
2324
+ "name": "json",
2325
+ "allowNo": false,
2326
+ "type": "boolean"
2327
+ },
2328
+ "date-format": {
2329
+ "description": "Format output dates using a template.",
2330
+ "env": "PPLS_DATE_FORMAT",
2331
+ "helpGroup": "GLOBAL",
2332
+ "name": "date-format",
2333
+ "default": "yyyy-MM-dd",
2334
+ "hasDynamicHelp": false,
2335
+ "multiple": false,
2336
+ "type": "option"
2337
+ },
2338
+ "header": {
2339
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
2340
+ "env": "PPLS_HEADERS",
2341
+ "helpGroup": "ENVIRONMENT",
2342
+ "name": "header",
2343
+ "hasDynamicHelp": false,
2344
+ "multiple": true,
2345
+ "type": "option"
2346
+ },
2347
+ "hostname": {
2348
+ "description": "Paperless-ngx base URL",
2349
+ "env": "PPLS_HOSTNAME",
2350
+ "helpGroup": "ENVIRONMENT",
2351
+ "name": "hostname",
2352
+ "hasDynamicHelp": false,
2353
+ "multiple": false,
2354
+ "type": "option"
2355
+ },
2356
+ "plain": {
2357
+ "description": "Format output as plain text.",
2358
+ "exclusive": [
2359
+ "json",
2360
+ "table"
2361
+ ],
2362
+ "helpGroup": "GLOBAL",
2363
+ "name": "plain",
2364
+ "allowNo": false,
2365
+ "type": "boolean"
2366
+ },
2367
+ "table": {
2368
+ "description": "Format output as table.",
2369
+ "exclusive": [
2370
+ "json",
2371
+ "plain"
2372
+ ],
2373
+ "helpGroup": "GLOBAL",
2374
+ "name": "table",
2375
+ "allowNo": false,
2376
+ "type": "boolean"
2377
+ },
2378
+ "token": {
2379
+ "description": "Paperless-ngx API token",
2380
+ "env": "PPLS_TOKEN",
2381
+ "helpGroup": "ENVIRONMENT",
2382
+ "name": "token",
2383
+ "hasDynamicHelp": false,
2384
+ "multiple": false,
2385
+ "type": "option"
2386
+ },
2387
+ "yes": {
2388
+ "char": "y",
2389
+ "description": "Skip confirmation prompt",
2390
+ "name": "yes",
2391
+ "allowNo": false,
2392
+ "type": "boolean"
2393
+ }
2394
+ },
2395
+ "hasDynamicHelp": false,
2396
+ "hiddenAliases": [],
2397
+ "id": "document-types:delete",
2398
+ "pluginAlias": "@nickchristensen/ppls",
2399
+ "pluginName": "@nickchristensen/ppls",
2400
+ "pluginType": "core",
2401
+ "strict": true,
2402
+ "isESM": true,
2403
+ "relativePath": [
2404
+ "dist",
2405
+ "commands",
2406
+ "document-types",
2407
+ "delete.js"
2408
+ ]
2409
+ },
2410
+ "document-types:list": {
2411
+ "aliases": [],
2412
+ "args": {},
2413
+ "description": "List document types",
2414
+ "examples": [
2415
+ "<%= config.bin %> <%= command.id %>"
2416
+ ],
2417
+ "flags": {
2418
+ "json": {
2419
+ "description": "Format output as json.",
2420
+ "helpGroup": "GLOBAL",
2421
+ "name": "json",
2422
+ "allowNo": false,
2423
+ "type": "boolean"
2424
+ },
2425
+ "date-format": {
2426
+ "description": "Format output dates using a template.",
2427
+ "env": "PPLS_DATE_FORMAT",
2428
+ "helpGroup": "GLOBAL",
2429
+ "name": "date-format",
2430
+ "default": "yyyy-MM-dd",
2431
+ "hasDynamicHelp": false,
2432
+ "multiple": false,
2433
+ "type": "option"
2434
+ },
2435
+ "header": {
2436
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
2437
+ "env": "PPLS_HEADERS",
2438
+ "helpGroup": "ENVIRONMENT",
2439
+ "name": "header",
2440
+ "hasDynamicHelp": false,
2441
+ "multiple": true,
2442
+ "type": "option"
2443
+ },
2444
+ "hostname": {
2445
+ "description": "Paperless-ngx base URL",
2446
+ "env": "PPLS_HOSTNAME",
2447
+ "helpGroup": "ENVIRONMENT",
2448
+ "name": "hostname",
2449
+ "hasDynamicHelp": false,
2450
+ "multiple": false,
2451
+ "type": "option"
2452
+ },
2453
+ "plain": {
2454
+ "description": "Format output as plain text.",
2455
+ "exclusive": [
2456
+ "json",
2457
+ "table"
2458
+ ],
2459
+ "helpGroup": "GLOBAL",
2460
+ "name": "plain",
2461
+ "allowNo": false,
2462
+ "type": "boolean"
2463
+ },
2464
+ "table": {
2465
+ "description": "Format output as table.",
2466
+ "exclusive": [
2467
+ "json",
2468
+ "plain"
2469
+ ],
2470
+ "helpGroup": "GLOBAL",
2471
+ "name": "table",
2472
+ "allowNo": false,
2473
+ "type": "boolean"
2474
+ },
2475
+ "token": {
2476
+ "description": "Paperless-ngx API token",
2477
+ "env": "PPLS_TOKEN",
2478
+ "helpGroup": "ENVIRONMENT",
2479
+ "name": "token",
2480
+ "hasDynamicHelp": false,
2481
+ "multiple": false,
2482
+ "type": "option"
2483
+ },
2484
+ "page": {
2485
+ "description": "Page number to fetch",
2486
+ "name": "page",
2487
+ "hasDynamicHelp": false,
2488
+ "multiple": false,
2489
+ "type": "option"
2490
+ },
2491
+ "page-size": {
2492
+ "description": "Number of results per page",
2493
+ "name": "page-size",
2494
+ "hasDynamicHelp": false,
2495
+ "multiple": false,
2496
+ "type": "option"
2497
+ },
2498
+ "id-in": {
2499
+ "description": "Filter by id list (comma-separated)",
2500
+ "exclusive": [
2501
+ "name-contains"
2502
+ ],
2503
+ "name": "id-in",
2504
+ "hasDynamicHelp": false,
2505
+ "multiple": false,
2506
+ "type": "option"
2507
+ },
2508
+ "name-contains": {
2509
+ "description": "Filter by name substring",
2510
+ "exclusive": [
2511
+ "id-in"
2512
+ ],
2513
+ "name": "name-contains",
2514
+ "hasDynamicHelp": false,
2515
+ "multiple": false,
2516
+ "type": "option"
2517
+ },
2518
+ "sort": {
2519
+ "description": "Sort results by the provided field",
2520
+ "name": "sort",
2521
+ "hasDynamicHelp": false,
2522
+ "multiple": false,
2523
+ "type": "option"
2524
+ }
2525
+ },
2526
+ "hasDynamicHelp": false,
2527
+ "hiddenAliases": [],
2528
+ "id": "document-types:list",
2529
+ "pluginAlias": "@nickchristensen/ppls",
2530
+ "pluginName": "@nickchristensen/ppls",
2531
+ "pluginType": "core",
2532
+ "strict": true,
2533
+ "enableJsonFlag": true,
2534
+ "isESM": true,
2535
+ "relativePath": [
2536
+ "dist",
2537
+ "commands",
2538
+ "document-types",
2539
+ "list.js"
2540
+ ]
2541
+ },
2542
+ "document-types:show": {
2543
+ "aliases": [],
2544
+ "args": {
2545
+ "id": {
2546
+ "description": "Document type id",
2547
+ "name": "id",
2548
+ "required": true
2549
+ }
2550
+ },
2551
+ "description": "Show document type details",
2552
+ "examples": [
2553
+ "<%= config.bin %> <%= command.id %> 123"
2554
+ ],
2555
+ "flags": {
2556
+ "json": {
2557
+ "description": "Format output as json.",
2558
+ "helpGroup": "GLOBAL",
2559
+ "name": "json",
2560
+ "allowNo": false,
2561
+ "type": "boolean"
2562
+ },
2563
+ "date-format": {
2564
+ "description": "Format output dates using a template.",
2565
+ "env": "PPLS_DATE_FORMAT",
2566
+ "helpGroup": "GLOBAL",
2567
+ "name": "date-format",
2568
+ "default": "yyyy-MM-dd",
2569
+ "hasDynamicHelp": false,
2570
+ "multiple": false,
2571
+ "type": "option"
2572
+ },
2573
+ "header": {
2574
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
2575
+ "env": "PPLS_HEADERS",
2576
+ "helpGroup": "ENVIRONMENT",
2577
+ "name": "header",
2578
+ "hasDynamicHelp": false,
2579
+ "multiple": true,
2580
+ "type": "option"
2581
+ },
2582
+ "hostname": {
2583
+ "description": "Paperless-ngx base URL",
2584
+ "env": "PPLS_HOSTNAME",
2585
+ "helpGroup": "ENVIRONMENT",
2586
+ "name": "hostname",
2587
+ "hasDynamicHelp": false,
2588
+ "multiple": false,
2589
+ "type": "option"
2590
+ },
2591
+ "plain": {
2592
+ "description": "Format output as plain text.",
2593
+ "exclusive": [
2594
+ "json",
2595
+ "table"
2596
+ ],
2597
+ "helpGroup": "GLOBAL",
2598
+ "name": "plain",
2599
+ "allowNo": false,
2600
+ "type": "boolean"
2601
+ },
2602
+ "table": {
2603
+ "description": "Format output as table.",
2604
+ "exclusive": [
2605
+ "json",
2606
+ "plain"
2607
+ ],
2608
+ "helpGroup": "GLOBAL",
2609
+ "name": "table",
2610
+ "allowNo": false,
2611
+ "type": "boolean"
2612
+ },
2613
+ "token": {
2614
+ "description": "Paperless-ngx API token",
2615
+ "env": "PPLS_TOKEN",
2616
+ "helpGroup": "ENVIRONMENT",
2617
+ "name": "token",
2618
+ "hasDynamicHelp": false,
2619
+ "multiple": false,
2620
+ "type": "option"
2621
+ }
2622
+ },
2623
+ "hasDynamicHelp": false,
2624
+ "hiddenAliases": [],
2625
+ "id": "document-types:show",
2626
+ "pluginAlias": "@nickchristensen/ppls",
2627
+ "pluginName": "@nickchristensen/ppls",
2628
+ "pluginType": "core",
2629
+ "strict": true,
2630
+ "isESM": true,
2631
+ "relativePath": [
2632
+ "dist",
2633
+ "commands",
2634
+ "document-types",
2635
+ "show.js"
2636
+ ]
2637
+ },
2638
+ "document-types:update": {
2639
+ "aliases": [],
2640
+ "args": {
2641
+ "id": {
2642
+ "description": "Document type id",
2643
+ "name": "id",
2644
+ "required": true
2645
+ }
2646
+ },
2647
+ "description": "Update a document type",
2648
+ "examples": [
2649
+ "<%= config.bin %> <%= command.id %> 123 --name \"Invoice\""
2650
+ ],
2651
+ "flags": {
2652
+ "json": {
2653
+ "description": "Format output as json.",
2654
+ "helpGroup": "GLOBAL",
2655
+ "name": "json",
2656
+ "allowNo": false,
2657
+ "type": "boolean"
2658
+ },
2659
+ "date-format": {
2660
+ "description": "Format output dates using a template.",
2661
+ "env": "PPLS_DATE_FORMAT",
2662
+ "helpGroup": "GLOBAL",
2663
+ "name": "date-format",
2664
+ "default": "yyyy-MM-dd",
2665
+ "hasDynamicHelp": false,
2666
+ "multiple": false,
2667
+ "type": "option"
2668
+ },
2669
+ "header": {
2670
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
2671
+ "env": "PPLS_HEADERS",
2672
+ "helpGroup": "ENVIRONMENT",
2673
+ "name": "header",
2674
+ "hasDynamicHelp": false,
2675
+ "multiple": true,
2676
+ "type": "option"
2677
+ },
2678
+ "hostname": {
2679
+ "description": "Paperless-ngx base URL",
2680
+ "env": "PPLS_HOSTNAME",
2681
+ "helpGroup": "ENVIRONMENT",
2682
+ "name": "hostname",
2683
+ "hasDynamicHelp": false,
2684
+ "multiple": false,
2685
+ "type": "option"
2686
+ },
2687
+ "plain": {
2688
+ "description": "Format output as plain text.",
2689
+ "exclusive": [
2690
+ "json",
2691
+ "table"
2692
+ ],
2693
+ "helpGroup": "GLOBAL",
2694
+ "name": "plain",
2695
+ "allowNo": false,
2696
+ "type": "boolean"
2697
+ },
2698
+ "table": {
2699
+ "description": "Format output as table.",
2700
+ "exclusive": [
2701
+ "json",
2702
+ "plain"
2703
+ ],
2704
+ "helpGroup": "GLOBAL",
2705
+ "name": "table",
2706
+ "allowNo": false,
2707
+ "type": "boolean"
2708
+ },
2709
+ "token": {
2710
+ "description": "Paperless-ngx API token",
2711
+ "env": "PPLS_TOKEN",
2712
+ "helpGroup": "ENVIRONMENT",
2713
+ "name": "token",
2714
+ "hasDynamicHelp": false,
2715
+ "multiple": false,
2716
+ "type": "option"
2717
+ },
2718
+ "name": {
2719
+ "description": "Document type name",
2720
+ "name": "name",
2721
+ "hasDynamicHelp": false,
2722
+ "multiple": false,
2723
+ "type": "option"
2724
+ }
2725
+ },
2726
+ "hasDynamicHelp": false,
2727
+ "hiddenAliases": [],
2728
+ "id": "document-types:update",
2729
+ "pluginAlias": "@nickchristensen/ppls",
2730
+ "pluginName": "@nickchristensen/ppls",
2731
+ "pluginType": "core",
2732
+ "strict": true,
2733
+ "isESM": true,
2734
+ "relativePath": [
2735
+ "dist",
2736
+ "commands",
2737
+ "document-types",
2738
+ "update.js"
2739
+ ]
2740
+ },
2741
+ "tags:add": {
2742
+ "aliases": [],
2743
+ "args": {
2744
+ "name": {
2745
+ "description": "Tag name",
2746
+ "name": "name",
2747
+ "required": true
2748
+ }
2749
+ },
2750
+ "description": "Create a tag",
2751
+ "examples": [
2752
+ "<%= config.bin %> <%= command.id %> Inbox"
2753
+ ],
2754
+ "flags": {
2755
+ "json": {
2756
+ "description": "Format output as json.",
2757
+ "helpGroup": "GLOBAL",
2758
+ "name": "json",
2759
+ "allowNo": false,
2760
+ "type": "boolean"
2761
+ },
2762
+ "date-format": {
2763
+ "description": "Format output dates using a template.",
2764
+ "env": "PPLS_DATE_FORMAT",
2765
+ "helpGroup": "GLOBAL",
2766
+ "name": "date-format",
2767
+ "default": "yyyy-MM-dd",
2768
+ "hasDynamicHelp": false,
2769
+ "multiple": false,
2770
+ "type": "option"
2771
+ },
2772
+ "header": {
2773
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
2774
+ "env": "PPLS_HEADERS",
2775
+ "helpGroup": "ENVIRONMENT",
2776
+ "name": "header",
2777
+ "hasDynamicHelp": false,
2778
+ "multiple": true,
2779
+ "type": "option"
2780
+ },
2781
+ "hostname": {
2782
+ "description": "Paperless-ngx base URL",
2783
+ "env": "PPLS_HOSTNAME",
2784
+ "helpGroup": "ENVIRONMENT",
2785
+ "name": "hostname",
2786
+ "hasDynamicHelp": false,
2787
+ "multiple": false,
2788
+ "type": "option"
2789
+ },
2790
+ "plain": {
2791
+ "description": "Format output as plain text.",
2792
+ "exclusive": [
2793
+ "json",
2794
+ "table"
2795
+ ],
2796
+ "helpGroup": "GLOBAL",
2797
+ "name": "plain",
2798
+ "allowNo": false,
2799
+ "type": "boolean"
2800
+ },
2801
+ "table": {
2802
+ "description": "Format output as table.",
2803
+ "exclusive": [
2804
+ "json",
2805
+ "plain"
2806
+ ],
2807
+ "helpGroup": "GLOBAL",
2808
+ "name": "table",
2809
+ "allowNo": false,
2810
+ "type": "boolean"
2811
+ },
2812
+ "token": {
2813
+ "description": "Paperless-ngx API token",
2814
+ "env": "PPLS_TOKEN",
2815
+ "helpGroup": "ENVIRONMENT",
2816
+ "name": "token",
2817
+ "hasDynamicHelp": false,
2818
+ "multiple": false,
2819
+ "type": "option"
2820
+ },
2821
+ "color": {
2822
+ "description": "Tag color (hex value)",
2823
+ "name": "color",
2824
+ "hasDynamicHelp": false,
2825
+ "multiple": false,
2826
+ "type": "option"
2827
+ },
2828
+ "inbox": {
2829
+ "description": "Mark tag as an inbox tag",
2830
+ "name": "inbox",
2831
+ "allowNo": false,
2832
+ "type": "boolean"
2833
+ },
2834
+ "parent": {
2835
+ "description": "Parent tag id",
2836
+ "name": "parent",
2837
+ "hasDynamicHelp": false,
2838
+ "multiple": false,
2839
+ "type": "option"
2840
+ }
2841
+ },
2842
+ "hasDynamicHelp": false,
2843
+ "hiddenAliases": [],
2844
+ "id": "tags:add",
2845
+ "pluginAlias": "@nickchristensen/ppls",
2846
+ "pluginName": "@nickchristensen/ppls",
2847
+ "pluginType": "core",
2848
+ "strict": true,
2849
+ "isESM": true,
2850
+ "relativePath": [
2851
+ "dist",
2852
+ "commands",
2853
+ "tags",
2854
+ "add.js"
2855
+ ]
2856
+ },
2857
+ "tags:delete": {
2858
+ "aliases": [],
2859
+ "args": {
2860
+ "id": {
2861
+ "description": "Tag id",
2862
+ "name": "id",
2863
+ "required": true
2864
+ }
2865
+ },
2866
+ "description": "Delete a tag",
2867
+ "examples": [
2868
+ "<%= config.bin %> <%= command.id %> 123"
2869
+ ],
2870
+ "flags": {
2871
+ "json": {
2872
+ "description": "Format output as json.",
2873
+ "helpGroup": "GLOBAL",
2874
+ "name": "json",
2875
+ "allowNo": false,
2876
+ "type": "boolean"
2877
+ },
2878
+ "date-format": {
2879
+ "description": "Format output dates using a template.",
2880
+ "env": "PPLS_DATE_FORMAT",
2881
+ "helpGroup": "GLOBAL",
2882
+ "name": "date-format",
2883
+ "default": "yyyy-MM-dd",
2884
+ "hasDynamicHelp": false,
2885
+ "multiple": false,
2886
+ "type": "option"
2887
+ },
2888
+ "header": {
2889
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
2890
+ "env": "PPLS_HEADERS",
2891
+ "helpGroup": "ENVIRONMENT",
2892
+ "name": "header",
2893
+ "hasDynamicHelp": false,
2894
+ "multiple": true,
2895
+ "type": "option"
2896
+ },
2897
+ "hostname": {
2898
+ "description": "Paperless-ngx base URL",
2899
+ "env": "PPLS_HOSTNAME",
2900
+ "helpGroup": "ENVIRONMENT",
2901
+ "name": "hostname",
2902
+ "hasDynamicHelp": false,
2903
+ "multiple": false,
2904
+ "type": "option"
2905
+ },
2906
+ "plain": {
2907
+ "description": "Format output as plain text.",
2908
+ "exclusive": [
2909
+ "json",
2910
+ "table"
2911
+ ],
2912
+ "helpGroup": "GLOBAL",
2913
+ "name": "plain",
2914
+ "allowNo": false,
2915
+ "type": "boolean"
2916
+ },
2917
+ "table": {
2918
+ "description": "Format output as table.",
2919
+ "exclusive": [
2920
+ "json",
2921
+ "plain"
2922
+ ],
2923
+ "helpGroup": "GLOBAL",
2924
+ "name": "table",
2925
+ "allowNo": false,
2926
+ "type": "boolean"
2927
+ },
2928
+ "token": {
2929
+ "description": "Paperless-ngx API token",
2930
+ "env": "PPLS_TOKEN",
2931
+ "helpGroup": "ENVIRONMENT",
2932
+ "name": "token",
2933
+ "hasDynamicHelp": false,
2934
+ "multiple": false,
2935
+ "type": "option"
2936
+ },
2937
+ "yes": {
2938
+ "char": "y",
2939
+ "description": "Skip confirmation prompt",
2940
+ "name": "yes",
2941
+ "allowNo": false,
2942
+ "type": "boolean"
2943
+ }
2944
+ },
2945
+ "hasDynamicHelp": false,
2946
+ "hiddenAliases": [],
2947
+ "id": "tags:delete",
2948
+ "pluginAlias": "@nickchristensen/ppls",
2949
+ "pluginName": "@nickchristensen/ppls",
2950
+ "pluginType": "core",
2951
+ "strict": true,
2952
+ "isESM": true,
2953
+ "relativePath": [
2954
+ "dist",
2955
+ "commands",
2956
+ "tags",
2957
+ "delete.js"
2958
+ ]
2959
+ },
2960
+ "tags:list": {
2961
+ "aliases": [],
2962
+ "args": {},
2963
+ "description": "List tags",
2964
+ "examples": [
2965
+ "<%= config.bin %> <%= command.id %>"
2966
+ ],
2967
+ "flags": {
2968
+ "json": {
2969
+ "description": "Format output as json.",
2970
+ "helpGroup": "GLOBAL",
2971
+ "name": "json",
2972
+ "allowNo": false,
2973
+ "type": "boolean"
2974
+ },
2975
+ "date-format": {
2976
+ "description": "Format output dates using a template.",
2977
+ "env": "PPLS_DATE_FORMAT",
2978
+ "helpGroup": "GLOBAL",
2979
+ "name": "date-format",
2980
+ "default": "yyyy-MM-dd",
2981
+ "hasDynamicHelp": false,
2982
+ "multiple": false,
2983
+ "type": "option"
2984
+ },
2985
+ "header": {
2986
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
2987
+ "env": "PPLS_HEADERS",
2988
+ "helpGroup": "ENVIRONMENT",
2989
+ "name": "header",
2990
+ "hasDynamicHelp": false,
2991
+ "multiple": true,
2992
+ "type": "option"
2993
+ },
2994
+ "hostname": {
2995
+ "description": "Paperless-ngx base URL",
2996
+ "env": "PPLS_HOSTNAME",
2997
+ "helpGroup": "ENVIRONMENT",
2998
+ "name": "hostname",
2999
+ "hasDynamicHelp": false,
3000
+ "multiple": false,
3001
+ "type": "option"
3002
+ },
3003
+ "plain": {
3004
+ "description": "Format output as plain text.",
3005
+ "exclusive": [
3006
+ "json",
3007
+ "table"
3008
+ ],
3009
+ "helpGroup": "GLOBAL",
3010
+ "name": "plain",
3011
+ "allowNo": false,
3012
+ "type": "boolean"
3013
+ },
3014
+ "table": {
3015
+ "description": "Format output as table.",
3016
+ "exclusive": [
3017
+ "json",
3018
+ "plain"
3019
+ ],
3020
+ "helpGroup": "GLOBAL",
3021
+ "name": "table",
3022
+ "allowNo": false,
3023
+ "type": "boolean"
3024
+ },
3025
+ "token": {
3026
+ "description": "Paperless-ngx API token",
3027
+ "env": "PPLS_TOKEN",
3028
+ "helpGroup": "ENVIRONMENT",
3029
+ "name": "token",
3030
+ "hasDynamicHelp": false,
3031
+ "multiple": false,
3032
+ "type": "option"
3033
+ },
3034
+ "page": {
3035
+ "description": "Page number to fetch",
3036
+ "name": "page",
3037
+ "hasDynamicHelp": false,
3038
+ "multiple": false,
3039
+ "type": "option"
3040
+ },
3041
+ "page-size": {
3042
+ "description": "Number of results per page",
3043
+ "name": "page-size",
3044
+ "hasDynamicHelp": false,
3045
+ "multiple": false,
3046
+ "type": "option"
3047
+ },
3048
+ "id-in": {
3049
+ "description": "Filter by id list (comma-separated)",
3050
+ "exclusive": [
3051
+ "name-contains"
3052
+ ],
3053
+ "name": "id-in",
3054
+ "hasDynamicHelp": false,
3055
+ "multiple": false,
3056
+ "type": "option"
3057
+ },
3058
+ "name-contains": {
3059
+ "description": "Filter by name substring",
3060
+ "exclusive": [
3061
+ "id-in"
3062
+ ],
3063
+ "name": "name-contains",
3064
+ "hasDynamicHelp": false,
3065
+ "multiple": false,
3066
+ "type": "option"
3067
+ },
3068
+ "sort": {
3069
+ "description": "Sort results by the provided field",
3070
+ "name": "sort",
3071
+ "hasDynamicHelp": false,
3072
+ "multiple": false,
3073
+ "type": "option"
3074
+ }
3075
+ },
3076
+ "hasDynamicHelp": false,
3077
+ "hiddenAliases": [],
3078
+ "id": "tags:list",
3079
+ "pluginAlias": "@nickchristensen/ppls",
3080
+ "pluginName": "@nickchristensen/ppls",
3081
+ "pluginType": "core",
3082
+ "strict": true,
3083
+ "enableJsonFlag": true,
3084
+ "isESM": true,
3085
+ "relativePath": [
3086
+ "dist",
3087
+ "commands",
3088
+ "tags",
3089
+ "list.js"
3090
+ ]
3091
+ },
3092
+ "tags:show": {
3093
+ "aliases": [],
3094
+ "args": {
3095
+ "id": {
3096
+ "description": "Tag id",
3097
+ "name": "id",
3098
+ "required": true
3099
+ }
3100
+ },
3101
+ "description": "Show tag details",
3102
+ "examples": [
3103
+ "<%= config.bin %> <%= command.id %> 123"
3104
+ ],
3105
+ "flags": {
3106
+ "json": {
3107
+ "description": "Format output as json.",
3108
+ "helpGroup": "GLOBAL",
3109
+ "name": "json",
3110
+ "allowNo": false,
3111
+ "type": "boolean"
3112
+ },
3113
+ "date-format": {
3114
+ "description": "Format output dates using a template.",
3115
+ "env": "PPLS_DATE_FORMAT",
3116
+ "helpGroup": "GLOBAL",
3117
+ "name": "date-format",
3118
+ "default": "yyyy-MM-dd",
3119
+ "hasDynamicHelp": false,
3120
+ "multiple": false,
3121
+ "type": "option"
3122
+ },
3123
+ "header": {
3124
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
3125
+ "env": "PPLS_HEADERS",
3126
+ "helpGroup": "ENVIRONMENT",
3127
+ "name": "header",
3128
+ "hasDynamicHelp": false,
3129
+ "multiple": true,
3130
+ "type": "option"
3131
+ },
3132
+ "hostname": {
3133
+ "description": "Paperless-ngx base URL",
3134
+ "env": "PPLS_HOSTNAME",
3135
+ "helpGroup": "ENVIRONMENT",
3136
+ "name": "hostname",
3137
+ "hasDynamicHelp": false,
3138
+ "multiple": false,
3139
+ "type": "option"
3140
+ },
3141
+ "plain": {
3142
+ "description": "Format output as plain text.",
3143
+ "exclusive": [
3144
+ "json",
3145
+ "table"
3146
+ ],
3147
+ "helpGroup": "GLOBAL",
3148
+ "name": "plain",
3149
+ "allowNo": false,
3150
+ "type": "boolean"
3151
+ },
3152
+ "table": {
3153
+ "description": "Format output as table.",
3154
+ "exclusive": [
3155
+ "json",
3156
+ "plain"
3157
+ ],
3158
+ "helpGroup": "GLOBAL",
3159
+ "name": "table",
3160
+ "allowNo": false,
3161
+ "type": "boolean"
3162
+ },
3163
+ "token": {
3164
+ "description": "Paperless-ngx API token",
3165
+ "env": "PPLS_TOKEN",
3166
+ "helpGroup": "ENVIRONMENT",
3167
+ "name": "token",
3168
+ "hasDynamicHelp": false,
3169
+ "multiple": false,
3170
+ "type": "option"
3171
+ }
3172
+ },
3173
+ "hasDynamicHelp": false,
3174
+ "hiddenAliases": [],
3175
+ "id": "tags:show",
3176
+ "pluginAlias": "@nickchristensen/ppls",
3177
+ "pluginName": "@nickchristensen/ppls",
3178
+ "pluginType": "core",
3179
+ "strict": true,
3180
+ "isESM": true,
3181
+ "relativePath": [
3182
+ "dist",
3183
+ "commands",
3184
+ "tags",
3185
+ "show.js"
3186
+ ]
3187
+ },
3188
+ "tags:update": {
3189
+ "aliases": [],
3190
+ "args": {
3191
+ "id": {
3192
+ "description": "Tag id",
3193
+ "name": "id",
3194
+ "required": true
3195
+ }
3196
+ },
3197
+ "description": "Update a tag",
3198
+ "examples": [
3199
+ "<%= config.bin %> <%= command.id %> 123 --name Inbox"
3200
+ ],
3201
+ "flags": {
3202
+ "json": {
3203
+ "description": "Format output as json.",
3204
+ "helpGroup": "GLOBAL",
3205
+ "name": "json",
3206
+ "allowNo": false,
3207
+ "type": "boolean"
3208
+ },
3209
+ "date-format": {
3210
+ "description": "Format output dates using a template.",
3211
+ "env": "PPLS_DATE_FORMAT",
3212
+ "helpGroup": "GLOBAL",
3213
+ "name": "date-format",
3214
+ "default": "yyyy-MM-dd",
3215
+ "hasDynamicHelp": false,
3216
+ "multiple": false,
3217
+ "type": "option"
3218
+ },
3219
+ "header": {
3220
+ "description": "Add a custom request header (repeatable, format: Key=Value)",
3221
+ "env": "PPLS_HEADERS",
3222
+ "helpGroup": "ENVIRONMENT",
3223
+ "name": "header",
3224
+ "hasDynamicHelp": false,
3225
+ "multiple": true,
3226
+ "type": "option"
3227
+ },
3228
+ "hostname": {
3229
+ "description": "Paperless-ngx base URL",
3230
+ "env": "PPLS_HOSTNAME",
3231
+ "helpGroup": "ENVIRONMENT",
3232
+ "name": "hostname",
3233
+ "hasDynamicHelp": false,
3234
+ "multiple": false,
3235
+ "type": "option"
3236
+ },
3237
+ "plain": {
3238
+ "description": "Format output as plain text.",
3239
+ "exclusive": [
3240
+ "json",
3241
+ "table"
3242
+ ],
3243
+ "helpGroup": "GLOBAL",
3244
+ "name": "plain",
3245
+ "allowNo": false,
3246
+ "type": "boolean"
3247
+ },
3248
+ "table": {
3249
+ "description": "Format output as table.",
3250
+ "exclusive": [
3251
+ "json",
3252
+ "plain"
3253
+ ],
3254
+ "helpGroup": "GLOBAL",
3255
+ "name": "table",
3256
+ "allowNo": false,
3257
+ "type": "boolean"
3258
+ },
3259
+ "token": {
3260
+ "description": "Paperless-ngx API token",
3261
+ "env": "PPLS_TOKEN",
3262
+ "helpGroup": "ENVIRONMENT",
3263
+ "name": "token",
3264
+ "hasDynamicHelp": false,
3265
+ "multiple": false,
3266
+ "type": "option"
3267
+ },
3268
+ "color": {
3269
+ "description": "Tag color (hex value)",
3270
+ "name": "color",
3271
+ "hasDynamicHelp": false,
3272
+ "multiple": false,
3273
+ "type": "option"
3274
+ },
3275
+ "inbox": {
3276
+ "description": "Mark tag as an inbox tag",
3277
+ "name": "inbox",
3278
+ "allowNo": true,
3279
+ "type": "boolean"
3280
+ },
3281
+ "name": {
3282
+ "description": "Tag name",
3283
+ "name": "name",
3284
+ "hasDynamicHelp": false,
3285
+ "multiple": false,
3286
+ "type": "option"
3287
+ },
3288
+ "parent": {
3289
+ "description": "Parent tag id",
3290
+ "name": "parent",
3291
+ "hasDynamicHelp": false,
3292
+ "multiple": false,
3293
+ "type": "option"
3294
+ }
3295
+ },
3296
+ "hasDynamicHelp": false,
3297
+ "hiddenAliases": [],
3298
+ "id": "tags:update",
3299
+ "pluginAlias": "@nickchristensen/ppls",
3300
+ "pluginName": "@nickchristensen/ppls",
3301
+ "pluginType": "core",
3302
+ "strict": true,
3303
+ "isESM": true,
3304
+ "relativePath": [
3305
+ "dist",
3306
+ "commands",
3307
+ "tags",
3308
+ "update.js"
3309
+ ]
3310
+ }
3311
+ },
3312
+ "version": "1.0.1"
3313
+ }