paperwork-cli(1)

📦
version 2.2.5 · 3 versions
, in ubuntu resolute, ubuntu stonking

💖 NAME 💖

paperwork-cli — the cli interface to paperwork, bestie. (Yes this is paperwork-cli(1), living in the User commands section of the manual, come thru 👑)

✨ SYNOPSIS ✨

paperwork-cli [-h] command

🦋 DESCRIPTION 🦋

Okay so basically? It's an interactive shell frontend for Paperwork. That's the whole vibe. You talk to it in a terminal and it does the Paperwork things for you 🫶

🎀 OPTIONS 🎀

  • -h, --help — Show help for paperwork-shell. That's it, that's the whole job 💅
  • sync — Synchronize the index(es) with the content of the work directory. Girl, this is the "refresh so nothing is lying to you" button 🔥
  • 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 you don't specify one, one will be selected randomly 🙈 (yes, randomly, no I'm not kidding)
      • --resolution RESOLUTION, -r RESOLUTION — Default resolution (dpi ; default=300)
  • scan [--doc_id DOC_ID] source_id — Scan pages. (Also, ngl, the original has a lil rogue ` dangling off the end of this line — it's giving chaos, we're leaving it untouched 💀)
    • --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. Ctrl+Z but for pixels ✨
    • --pages PAGES, -p PAGES — (that's the pages, bestie)
  • 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 — (yeah, just the doc id, no notes)
    • --modifiers, -m MODIFIERS — List of image modifiers (comma separated, possible values: ['rotate_clockwise', 'rotate_counterclockwise', 'color_equalization'])
    • --pages, -p PAGES — (the pages, again, as one does)
  • delete [--pages PAGES] [doc_ids [doc_ids ...]] — Delete a document or a page. Be so careful, this is the point of no return 😭
    • 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 (bestie the manual really spells it like that, periodt, we don't fix what we didn't break 💀)
    • 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

Look at that chain of filters go. Ate. No crumbs. 👑

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

🌸 AUTHOR 🌸

Thomas Perret, 2019-2020 🫶

GPL-3.0+

That's the whole page, bestie — paperwork-cli version 2.0, hanging out in the User commands section, filed under paperwork-cli(1). Go forth and CLI, iykyk ✨🎀💅

📦 where this page comes from