---
name: "paperwork-cli"
section: "1"
platform: "linux"
package: "paperwork-shell"
version: "2.2.5-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/paperwork-cli"
---

# paperwork-cli(1)

cli interface to paperwork

## NAME

paperwork-cli - cli interface to paperwork

## 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-json/1.md), [paperwork-gtk(1)](/paperwork-gtk/1.md)

- •

  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\> )

## AUTHOR

Thomas Perret, 2019-2020

## COPYRIGHT

GPL-3.0+