schtobia/paperless-client
1
0
Fork 0
Code Issues Pull requests Activity
A simple client for paperless-ngx https://paperless-ngx.com/, written in dash
7 commits 1 branch 1 tag 46 KiB
Shell 100%
Find a file
Tobias Schmidl 3dd43b1bab docs: extended README
2024-11-21 20:45:58 +01:00
LICENSES added initial 2024-11-14 09:38:55 +01:00
.ecrc added initial 2024-11-14 09:38:55 +01:00
.ecrc.license added initial 2024-11-14 09:38:55 +01:00
.editorconfig added initial 2024-11-14 09:38:55 +01:00
.gitignore added initial 2024-11-14 09:38:55 +01:00
.pre-commit-config.yaml chore: updated pre-commit hooks 2024-11-14 10:29:39 +01:00
LICENSE added initial 2024-11-14 09:38:55 +01:00
paperless.sh style: correct indention for the usage 2024-11-14 10:32:15 +01:00
README.md docs: extended README 2024-11-21 20:45:58 +01:00

README.md

paperless-client

pre-commit enabled

This simple client is a wrapper around the paperless-ng API. It allows you to upload documents to your paperless-ng instance. By design it doesn't use anything besides curl, so that it can be used in a wide range of environments, like Alpine Linux or OpenWRT.

Installation

curl -ROLf1 https://git.schmidl.dev/schtobia/paperless-client/raw/branch/master/paperless.sh
chmod +x paperless.sh
echo BASEURL=<your paperless-ng instance> > .env
echo TOKEN=<your paperless-ng token> >> .env

Usage

paperless.sh get_tasks | put_document <file>

commands:
    get_tasks       Get the list of tasks. This is not formatted, i.e. you'll
                    have to pipe it yourself through a formatter.
    put_document    Uploads the document under <file> to your paperless
                    instance.

return values:
    If everything went alright, paperless.sh returns 0. Every other return
    value indicates an error.