whatisgithub

What is paperless-ai?

clusterzx/paperless-ai — explained in plain English

Analysis updated 2026-06-26

5,649JavaScriptAudience · generalComplexity · 3/5Setup · moderate

In one sentence

Paperless-AI is a Docker add-on for Paperless-ngx that automatically tags and categorizes incoming documents using AI, and lets you ask plain-English questions about your document archive through a chat interface.

Mindmap

mindmap
  root((Paperless-AI))
    What it does
      Auto-tags documents
      AI categorization
      Document chat
    AI Backends
      OpenAI
      Ollama local
      DeepSeek
      Google Gemini
    Features
      RAG search
      Manual review mode
      Tag rules
    Setup
      Docker container
      Paperless-ngx required
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Automatically assign titles, tags, and document types to every new document arriving in Paperless-ngx without manual work

USE CASE 2

Ask plain-English questions about your document archive like 'when did I sign my rental agreement' and get answers from your actual files

USE CASE 3

Run AI document processing locally using Ollama so your documents never leave your machine

What is it built with?

JavaScriptDockerOpenAI APIOllamaPaperless-ngx

How does it compare?

clusterzx/paperless-ailouiszhai/toolazgaar/fantasy-map-generator
Stars5,6495,6495,653
LanguageJavaScriptJavaScriptJavaScript
Setup difficultymoderateeasyeasy
Complexity3/51/52/5
Audiencegeneraldeveloperwriter

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 1h+

Requires Paperless-ngx already running, project is not actively maintained and future development depends on official Paperless-ngx AI support.

No license information was mentioned in the explanation.

So what is it?

Paperless-AI is an add-on for Paperless-ngx, an open source document management system that scans and organizes physical and digital documents. This add-on connects Paperless-ngx to AI language models so that incoming documents are analyzed and categorized automatically. When a new document arrives, the system reads its content and assigns a title, tags, document type, and correspondent without the user having to do it manually. The AI backends it can connect to include OpenAI, Ollama (which lets you run AI models locally on your own hardware), DeepSeek, Google Gemini, and several other compatible services. Running models locally through Ollama means documents never leave your machine, which the README notes as a privacy benefit. Beyond automatic tagging, the tool includes a chat feature powered by a technique called Retrieval-Augmented Generation (RAG). RAG is an approach where the AI searches through your actual documents to answer questions, rather than relying purely on its training. You can ask things like "when did I sign my rental agreement" or "which documents mention my health insurance" and get answers drawn from the specific files in your archive. There is also a manual processing mode, accessible through a web interface, for reviewing and tagging sensitive documents yourself rather than having AI handle them automatically. Tag rules let you control which documents get processed and what output tags are applied. The project is distributed as a Docker container, which is a packaged format that simplifies installation. The README includes an important notice that the project is not currently being actively maintained, and the author is considering whether to continue depending on how official AI support in Paperless-ngx itself develops.

Copy-paste prompts

Prompt 1
I have Paperless-ngx running with Docker. How do I add Paperless-AI as an add-on and configure it to automatically tag incoming documents using OpenAI?
Prompt 2
Set up Paperless-AI with Ollama so all document analysis runs locally on my machine without sending anything to the cloud. What are the steps?
Prompt 3
How do I use the Paperless-AI chat feature to search my document archive? Show me example questions I can ask about my contracts and invoices.
Prompt 4
I want to create tag rules in Paperless-AI that process some documents automatically but route sensitive ones to manual review. How do I configure this?

Frequently asked questions

What is paperless-ai?

Paperless-AI is a Docker add-on for Paperless-ngx that automatically tags and categorizes incoming documents using AI, and lets you ask plain-English questions about your document archive through a chat interface.

What language is paperless-ai written in?

Mainly JavaScript. The stack also includes JavaScript, Docker, OpenAI API.

What license does paperless-ai use?

No license information was mentioned in the explanation.

How hard is paperless-ai to set up?

Setup difficulty is rated moderate, with roughly 1h+ to a first successful run.

Who is paperless-ai for?

Mainly general.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.