1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
=============
paperwork-cli
=============
--------------------------
cli interface to paperwork
--------------------------
:Author: Thomas Perret, 2019-2020
:Version: 2.0
:Copyright: GPL-3.0+
:Manual section: 1
:Manual group: User commands
SYNOPSIS
========
paperwork-cli [-h] command
DESCRIPTION
===========
Interactive shell frontend for Paperwork.
OPTIONS
=======
-h, --help Show help for paperwork-shell
**sync**
Synchronize the index(es) with the content of the work directory
**show** [`--pages`]
Show the content of a document
`--pages`
Pages to show: 1,4 or 1-10 (default: all)
**search** [`--limit`]
Search keywords in documents
`--limit, -l` *LIMIT*
Maximum number of results (default: 50)
**scanner** `subcommand`
Manage scanner configuration
`list`
List all scanners and their possible settings
`get`
Show the currently selected scanner and its settings
`set` [`--source` SOURCE] [`--resolution` RESOLUTION] `device_id`
Define which scanner and which settings to use
`--source` SOURCE
Default source on the scanner to use (if not specified, one will be selected randomly)
`--resolution` RESOLUTION, `-r` RESOLUTION
Default resolution (dpi ; default=300)
**scan** [`--doc_id` DOC_ID] `source_id``
Scan pages
`--doc_id` DOC_ID, `-d` DOC_ID
Document to which the scanned pages must be added
**reset** [`--pages` PAGES] doc_id
Reset a page to its original content
`--pages` PAGES, `-p` PAGES
**rename** `source_doc_id` `dest_doc_id`
Change a document identifier
`source_doc_id`
Document to rename
`dest_doc_id`
New name for the document
**ocr** [`--pages` PAGES] doc_id
OCR document or pages
`--pages` PAGES, `-p` PAGES
Pages to OCR (single integer, range or comma-separated list, default: all pages)
**move** `source_doc_id` `source_page` `dest_doc_id` `dest_page`
Move a page
`source_doc_id`
Source document
`source_page`
Page to move
`dest_doc_id`
Destination document
`dest_page`
Target page number
**label** `subcommand`
Commands to manage labels
`list`
Show labels
`show` [`doc_ids` [`doc_ids` ...]]
Show labels from doc_ids
`doc_ids`
Document(s)
`add` [`--color` COLOR] `doc_id` `label_name`
Add label `label_name` to document `doc_id` with optional color `COLOR`
`remove` `doc_id` `label_name`
Remove label `label_name` from document `doc_id`
`delete` `label_name`
Delete label `label_name`
**import** [`--doc_id` DOC_ID] [`files` [`files` ...]]
Import file(s)
`files`
Files to import
`--doc_id`, `--doc`, `-d` DOC_ID
Target document for import
**extra_text** `subcommand`
Manage additional text attached to documents
`get`
Get a document additional text
`set`
Set a document additional text
**export** [`--pages` PAGES] [`--filters` FILTERS] [`--out` OUT] `doc_id`
Export a document, a page, or a set of pages.
`doc_id`
Document to export
`--pages`, `-p` PAGES
Pages to export (single integer, range or comma-separated list, default: all pages)
`--filters`, `-f` FILTERS
Export filters. Specify this option once for each filter to apply (ex: '-f grayscale -f jpeg').
`--out`, `-o` OUT
Output file/directory. If not specified, will list the filters that could be chained after those already specified.
**edit** [`--modifiers` MODIFIERS] [`--pages` PAGES] doc_id
Edit page
`doc_id`
`--modifiers`, `-m` MODIFIERS
List of image modifiers (comma separated, possible values: ['rotate_clockwise', 'rotate_counterclockwise', 'color_equalization'])
`--pages`, `-p` PAGES
**delete** [`--pages` PAGES] [`doc_ids` [`doc_ids` ...]]
Delete a document or a page
`doc_ids`
Target documents
`--pages`, `-p` PAGES
Pages to delete (single integer, range or comma-separated list, default: all pages)
**about**
About Paperwork
**plugins** `subcommand`
Manage paperwork-cli plugins
`list`
Show plugins enabled for paperwork-cli
`add`
Add plugin in papaerwork-cli
`remove`
Remove plugin from paperwork-cli
`reset`
Clean up your mess by resetting the plugin list to its default value
`show`
Show information regarding a plugin (must be enabled)
**config** `subcommand`
Manage Paperwork configuration
`get`
Get a value from Paperwork's configuration
`put`
Set a value in Paperwork's configuration
`show`
Show Paperwork's configuration
`list_types`
Show value types you can use from command line
EXAMPLE
=======
* Export a document:
`paperwork-cli` export 20150303_2314_39 -p 2 -f img_boxes -f grayscale -f jpeg -o ~/tmp/pouet.jpg
SEE ALSO
========
* paperwork-json(1), paperwork-gtk(1)
* The paperwork frontend introduction (file:///usr/share/doc/paperwork-gtk/intro.pdf)
* The paperwork frontend usage manual (file:///usr/share/doc/paperwork-gtk/usage.pdf)
|
