| name | paperless |
| description | Search and manage documents in Paperless-ngx document management system. Use when the user asks about documents, invoices, receipts, tax forms, bills, or wants to search their document library. |
| allowed-tools | Bash, Read |
Paperless-ngx
Interact with Paperless-ngx document management system via CLI.
Setup
Environment: ~/.secrets.env (PAPERLESS_URL, PAPERLESS_TOKEN) - loaded by wrapper
Run commands via:
paperless-cli <command>
Commands Reference
See CLI-REFERENCE.md for full command documentation.
Quick Reference
| Command | Purpose |
|---|---|
search [query] |
Full-text search with filters |
list |
Recent documents, --inbox for inbox |
get <id> |
Document details and content |
download <id> |
Download original file |
edit <id> |
Edit title/correspondent/type |
similar <id> |
Find similar documents |
add-tag <id> <tag> |
Add tag to document |
remove-tag <id> <tag> |
Remove tag from document |
tags |
List all tags |
correspondents |
List all correspondents |
types |
List all document types |
stats |
System statistics |
Workflow
- Start with
searchorlistto find documents - Use
get <id>to read full content - Use
add-tag/remove-tagto organize - Use
similar <id>to find related documents - Use
download <id>to save original files
Examples
Important: Flags must come BEFORE positional arguments (query text).
"Find my tax documents from 2023"
search "tax 2023"
# or with filters (flags before query):
search --tag tax --after 2023-01-01 --before 2024-01-01
"What's in my inbox?"
list --inbox
"Show me that W-2"
get 1234
"Tag document 1234 as reviewed"
add-tag 1234 reviewed --create
"Find similar documents to this receipt"
similar 1234
"Download that PDF"
download 1234