Is paperless-ai still maintained?

Yes, active. Last change 2 days ago. Latest release v4.0.0, 4 days ago.

How widely used is paperless-ai?

Widely used. 6k stars, 1 year old. As with any download, get it from the official repo.

gitmanual

Reading the repo

Opening the box…

How to set up paperless-ai (clusterzx/paperless-ai) · gitmanual

Assembly instructions

clusterzx/paperless-ai

An automated document analyzer for Paperless-ngx using OpenAI API, Ollama, Deepseek-r1, Azure and all OpenAI API compatible Services to automatically analyze and tag your documents.

Node.jsVite#ai#automation#gemma#llama

Before you start

Is it free?: YesOpen source (MIT).
Still maintained?: Yes, activeLast change 2 days ago. Latest release v4.0.0, 4 days ago.
How widely used?: Widely used6k stars, 1 year old. As with any download, get it from the official repo.

Difficulty: Easy
Time: about 5 min
Stars: ★ 6,020
Activity: Updated this month

GitHub didn't answer, so this is the saved copy from 14 h ago

Will it work on macOS?

Yes, with Docker on macOS

It's a self-hosted app: the README runs it with Docker, and you open it in your browser.
On macOS that means installing Docker Desktop first.

Your system

macOS Windows Linux

Start here

Website ↗clusterzx.github.ioThe project's own site.

Run it with Docker

A self-hosted app: Docker runs it on your computer and you open it in the browser. Needs Docker Desktop (or Docker Engine on Linux). Run docker compose commands inside the cloned repo folder.

DockerNeeds Docker

docker compose up -d

From the README, exactly as the maintainers wrote it.

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

GitManual AI Agent reads the 11 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js >=22.12.0runtime
1×npm package manager

Share this manual

Is this your repo?

Add a badge to your README so newcomers find these steps.

[![Setup manual](https://gitmanual.com/clusterzx/paperless-ai/badge.svg)](https://gitmanual.com/clusterzx/paperless-ai)

Good to know

Dockerfile available (base image: node:22-bookworm-slim).

Details

License: MIT
Open issues: 9
Branch: main

package.json scripts (15)

devconcurrently -k -n server,web -c blue,magenta "npm:dev:server" "npm:dev:web"
dev:servertsx watch --clear-screen=false src/server/index.ts
dev:webvite
buildnpm run build:web && npm run build:server
build:servertsc -p tsconfig.server.json
build:webvite build
startnode dist/server/index.js
typechecktsc -p tsconfig.json && tsc -p src/web/tsconfig.json
linteslint .
formatprettier --write .
testvitest run
test:watchvitest
test:e2eplaywright test
checknpm run typecheck && npm run lint && npm test
demotsx e2e/demo-server.ts

Files we read (11)

.env.example

.github/workflows/ci.yml

.github/workflows/docker-build-push.yml

.github/workflows/manualPush.yml

.github/workflows/release-to-discord.yml

.github/workflows/stale.yml

CONTRIBUTING.md

Dockerfile

README.md

docker-compose.yml

package.json

175 files in the repo

Contact

clusterzx/paperless-ai

Before you start

Your setup manual for paperless-ai

What's inside

Handy for

Yes, with Docker on macOS

Start here

Run it with Docker

Did you get it running?

Still stuck? Get a written guide

Yes, with Docker on macOS

Start here

Run it with Docker

Did you get it running?

Still stuck? Get a written guide

More like paperless-ai that run on macOS