Documentation · Setup Guide · Quickstart
Agent-native document system of record
Docbank is an open-source document vault for people, applications, and agents. It runs on your own machine. It imports files, email, photos, and recordings, makes their text searchable, and keeps every version you save. When you need to hand records to someone else, it exports the versions you checked.
Use it from the command line, a local web app, a terminal browser, or an
authenticated HTTP API, or connect an agent with docbank mcp. They all talk
to the daemon, a local background process that owns the vault. A Go application
can instead embed a vault of its own.
Alpha software. Keep your own copies of anything irreplaceable, and verify a backup before you rely on it.
| Task | Guide |
|---|---|
| Import and organize records | Importing and tagging |
| Find a document | Searching and search by meaning |
| Extract a document's text and read it | Document processing |
| Read email and follow attachments | Web email reader |
| Browse photos and organize albums | Photo assets |
| Export documents and search reports | Verified bundles and search reports |
| Keep earlier content versions | Editing and versions |
| Automate filing and retrieval | Agent integration |
| Recover deleted documents | Trash and recovery |
| Create and verify backups | Backup and restore |
| Keep a permanent record of changes | Audited history |
| Add filesystem or S3-compatible storage | Multi-store storage |
Docbank does not synchronize a working folder across devices or create public share links. The capability guide lists what it does today, and the roadmap lists what is planned.
Linux or macOS:
curl -fsSL https://docbank.ai/install.sh | shWindows PowerShell:
irm https://docbank.ai/install.ps1 | iexThe installers pick the native Linux, macOS, or Windows archive for amd64 or
arm64. They refuse to install an archive whose digest does not match the
release's SHA256SUMS. You can also download the archives from
GitHub Releases and verify them
yourself.
To build from source, install Go 1.27.4 or newer, CGO, a C compiler, Node 24+, and npm:
git clone https://github.com/kenn-io/docbank.git
cd docbank
make installThe setup guide lists the build requirements for each platform. For a stock image configured through environment settings and mounted secrets, see Run in a container.
The first data command creates the vault and starts its daemon:
docbank document add ~/Documents --dest /archive
docbank document tree /archive
docbank search "tax return"
docbank webFor empty search results, see the search hints.
Retrieve a file, list its versions, replace its content, and rename it. Docbank verifies a file before handing it back. Replacing content adds a version and leaves the earlier ones in place, and a rename keeps the document's ID:
docbank document get /archive/Documents/receipt.pdf ./receipt.pdf
docbank document versions list /archive/Documents/receipt.pdf
docbank document put revised-receipt.pdf /archive/Documents/receipt.pdf
docbank document move /archive/Documents/receipt.pdf /archive/Documents/receipt-2026.pdf
docbank vault verifyPDF text is indexed locally on import, with no setup. With no configured profile, the Text tab shows retained PDF page text. Configured profiles keep their own text and processing state. Office text and OCR use configured processing profiles.
Create a backup, verify it, and restore it into a separate directory to check:
docbank backup init --repo ~/Backups/docbank
docbank backup create --repo ~/Backups/docbank --tag first-import
docbank backup verify --repo ~/Backups/docbank
docbank backup restore --repo ~/Backups/docbank --target ~/Restores/docbank-testThe ten-minute quickstart covers versions, tags, search, trash, maintenance, and restore.
- Standalone. One daemon owns the vault. The CLI, browser, TUI, scripts, and external agents all go through its authenticated API on the local machine.
- Embedded. A Go application owns each vault in its own process. Every vault has its own root directory, and you choose CGO or pure-Go SQLite.
- Secondary storage. Docbank verifies content in configured filesystem and S3-compatible stores but does not encrypt it. Restrict those stores to their owner and encrypt them at the storage layer.
- Backup. Copying the local database and primary blob directory while the
daemon is stopped gives a complete backup only if primary storage has a
verified copy of every content file the vault keeps.
docbank backup createalso includes content held only in secondary stores. See the backup guide for the full rules.
- Documentation homepage and visual tour
- Setup and quickstart
- Capabilities and vault lifecycle
- Web application and terminal browser
- Multi-store storage and backup & restore
- Docbank for agents and integration guide
- Embed in Go and document processing packages
- CLI reference and architecture overview
- Usage reporting: anonymous, and off unless you agree
Docbank has a sibling, msgvault, which archives communications. Msgvault preserves an immutable record of messages. Docbank manages working documents that people and agents still organize, retrieve, version, and use.
Start with the development guide for the repository layout, package ownership, generated clients, and checks. Follow AGENTS.md and the documentation guide when updating code or documentation.
Copyright 2026 Kenn Software LLC.
Docbank is licensed under the Apache License, Version 2.0. See NOTICE for attribution information.
