Skip to content

patfrey/PaperMore

Repository files navigation

PaperMore - simple report generation for paperless-ngx

PaperMore is a small CLI tool for generating document reports from paperless-ngx. It can output to csv, or pdf (powered by QuestPDF).

Usage

Run the CLI with the required arguments:

PaperMore.exe --url <API_URL> --token <API_TOKEN> --format <csv|pdf> --path <OUTPUT_PATH>

Options

  • --url: URL of your paperless instance
  • --token: API token for authentication
  • --format: (optional) Output format (csv or pdf, default pdf)
  • --path: Path to save the generated report
  • --blanklines: Add blank lines to the PDF report, useful reserve space for newly added documents
  • --batch-size: Number of documents queried in one go (default: 50)
  • --asn-from: Sets the lower bound for filtering documents by ASN
  • --asn-to: Sets the upper bound for filtering documents by ASN

Note: BasicAuth login to the paperless api is not supported

Contributing

Contributions are welcome! Please submit issues or pull requests via GitHub.

About

Document report generator for paperless-ngx

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •  

Languages