A specialized document management skill for interacting with Paperless-ngx to search, upload, and organize digital archives via API.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install paperless-docs
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install paperless-docs using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Paperless-ngx?
The Paperless-ngx skill is a comprehensive integration designed to bridge the gap between your local environment and your Paperless-ngx document server. It leverages the REST API to provide deep control over your digital archive, allowing for seamless document ingestion and retrieval. By utilizing Openclaw Skills, users can transform their document workflows into automated pipelines that handle everything from OCR text extraction to complex metadata tagging.
This skill is particularly valuable for developers and power users who need to programmatically manage large volumes of files. It supports full-text search capabilities and provides structured access to correspondents, tags, and document types, ensuring that your self-hosted document management system remains organized and accessible without needing to rely solely on the web interface.
Paperless-ngx Use Cases
- Automating the upload of invoices and receipts directly from a CLI or script.
- Performing advanced full-text searches to find specific records within a massive document library.
- Extracting OCR-processed text from PDF documents for use in other data processing tasks.
- Managing and creating organizational metadata such as tags and correspondents on the fly.
- Downloading archived PDF/A versions of documents for offline access or backup purposes.
How Paperless-ngx Works
- The skill authenticates with your Paperless-ngx instance using a provided API token and host URL.
- Commands are executed via Node.js scripts that translate user intent into structured REST API requests.
- For uploads, the skill handles multi-part form data, allowing for the inclusion of titles, tags, and custom dates.
- For searches, it queries the Paperless-ngx database and returns results in a clean JSON format compatible with tools like jq.
- The skill provides direct access to the document lifecycle, from initial ingestion and OCR processing to final archival.
Paperless-ngx Setup
To get started with this skill in your Openclaw Skills environment, configure your credentials in ~/.clawdbot/clawdbot.json:
{
"env": {
"PAPERLESS_URL": "http://your-paperless-host:8000",
"PAPERLESS_TOKEN": "your-api-token"
}
}
Alternatively, you can define the skill-specific entry:
{
"skills": {
"entries": {
"paperless-ngx": {
"env": { "PAPERLESS_URL": "http://your-paperless-host:8000" },
"apiKey": "your-api-token"
}
}
}
}
Paperless-ngx Data Schema & Taxonomy
The skill interacts with several core entities within the Paperless-ngx ecosystem, returning data in structured formats for easy integration.
| Entity | Key Attributes |
|---|---|
| Document | ID, Title, Content (OCR text), Created Date, Tags, Document Type, Correspondent |
| Tag | ID, Name, Slug, Color |
| Correspondent | ID, Name, Slug, Matching Algorithm |
| Document Type | ID, Name, Slug |
Paperless-ngx Advanced Features
- Enhanced full-text search across all stored documents using the Openclaw Skills framework.
- High-fidelity retrieval of OCR content using the --content and --full flags for data mining.
- Support for downloading either original source files or the generated PDF/A archived versions.
- Command-line metadata management, including the creation of new tags and correspondents.
- JSON-native output for every command, enabling complex automation workflows and shell piping.
SKILL.md
Loading
Related Openclaw Skills
GRVT Exchange CLI
A professional-grade command-line interface and Node.js library for trading perpetuals, futures, and options on the GRVT exchange.
sonoscli
A robust command-line interface for discovering, controlling, and grouping Sonos speakers within your local network.
Substack Article Formatter
A technical formatting tool that converts plain text into Substack-optimized HTML for seamless copy-pasting.
Figma Design Analysis & Export
A professional-grade Figma integration for programmatically analyzing design systems, auditing WCAG compliance, and automating multi-format asset exports.
Paperless-ngx
A powerful bridge between your AI agent and Paperless-ngx for seamless document management, metadata tagging, and OCR retrieval.
WeKan CLI Skill
A powerful CLI-driven skill to manage cards, lists, and boards on self-hosted WeKan servers through an AI agent.
Featured*
