Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add command to bulk-download all documents #17

Merged
merged 9 commits into from
Jan 29, 2023
Merged

Add command to bulk-download all documents #17

merged 9 commits into from
Jan 29, 2023

Conversation

ccremer
Copy link
Owner

@ccremer ccremer commented Jan 28, 2023

Summary

Adds bulk-download subcommand with following options

NAME:
   paperless-cli bulk-download - Downloads all documents at once

USAGE:
   paperless-cli bulk-download [command options] [arguments...]

OPTIONS:
   --url value          URL endpoint of the paperless instance. [$PAPERLESS_URL]
   --username value     username for BasicAuth of the paperless instance. Leave empty to use token authentication. [$PAPERLESS_USERNAME]
   --token value        password or token of the paperless instance. [$PAPERLESS_TOKEN]
   --target-path value  target file path where documents are downloaded. (default: documents.zip) [$DOWNLOAD_TARGET_PATH]
   --content value      selection of document variant. (default: "archive") [$DOWNLOAD_CONTENT]
   --unzip              unzip the downloaded file. (default: false) [$DOWNLOAD_UNZIP]
   --overwrite          deletes existing file(s) before downloading. (default: false) [$DOWNLOAD_OVERWRITE]
   --help, -h           show help (default: false)

Closes #16

This command is useful to create a local copy of Paperless documents (without the filtering and searching ofc) for offline usage. Works best if the file name formatting configured in Paperless makes somewhat sense for local usage.

⚠️ Please note that this is not a full-fledged backup solution for your Paperless instance.

Checklist

  • Categorize the PR by setting a good title and adding one of the labels:
    kind:bug, kind:enhancement, kind:documentation, kind:change, kind:breaking, kind:dependency
    as they show up in the changelog
  • Link this PR to related issues

@ccremer ccremer added the kind:enhancement New feature or request label Jan 28, 2023
@ccremer ccremer marked this pull request as ready for review January 29, 2023 10:05
@ccremer ccremer merged commit 14c204d into master Jan 29, 2023
@ccremer ccremer deleted the bulk-dl branch January 29, 2023 11:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bulk-download
1 participant