Documentation
Learn VaultBook
inside and out
From your first note to advanced AI search and encryption — everything you need to master the offline-first workspace that runs from a single file.
AI-powered search
AES-256-GCM
12+ built-in tools
Zero cloud
Version history
1
Download & unzip
Grab the single ZIP for your tier. Inside you'll find one HTML file and a license — that's everything.
2
Open in your browser
Double-click the HTML file in any Chromium-based browser (Chrome, Edge, Brave, Arc). No install, no runtime.
3
Connect a folder
Point VaultBook at any local folder containing your license.json. Your notes, files, and versions live there — fully under your control.
Browse by topic
Everything, organized
Jump to the area you need — each section covers concepts, features, and practical tips.
🧠
AI & Smart Search
Suggestions, QA, OCR, relevance learning
✍️
Writing & Editing
Rich text, sections, markdown, version history
📂
Organization
Pages, labels, tabs, filters, Kanban
🔐
Security & Encryption
AES-256-GCM, lock screen, zero network
🛠️
Built-in Tools
12+ productivity tools, zero installs
📎
Files & Indexing
Attachments, deep indexing, PDF/XLSX/PPTX
📅
Scheduling & Analytics
Calendar, due dates, charts, insights
🏗️
Architecture & Storage
File system, data model, autosave
🧠
AI & Smart Search
AI Suggestions — the Sparkle pager Plus
The 4-page carousel sits at the top of your workspace and rotates through: Suggestions (upcoming scheduled entries + weekday reading patterns from the last 4 weeks), Recently Read (up to 100 deduped entries with timestamps), Recent Files, and Recent Tools. It learns a personalized relevance distribution across your entire library — the more you use VaultBook, the smarter it gets.
Ask a Question — natural-language QA search Plus
Type any question in natural language. VaultBook searches across titles (8×), labels (6×), inline OCR text (5×), body content (4×), sections (3×), main attachments (2×), and section attachments (1×) — all weighted for relevance. Results are paginated 6 per page with navigable prev/next. The system automatically warms up attachment text for the top 12 candidates in the background.
Vote-based learning & reranking Pro
Upvote or downvote any search result or related entry suggestion. Votes persist across sessions and directly influence sort ordering — upvoted items float to the top (+1M score boost), downvoted items sink. The add-to-note button lets you prefill a new entry from any result. An educational confirmation dialog (which you can disable) explains how voting improves your library over time.
Related Entries — contextual suggestions Pro
When you're browsing any entry, Related Entries analyzes contextual similarity and surfaces notes you might want to revisit. Results appear with a fade-in animation and are paginated. Use Reddit-style upvote/downvote on each pair to train the relevance model — votes are saved to your repository and improve suggestions across sessions.
Inline OCR — search text inside images Plus
Every inline image in your entries is automatically OCR'd. Extracted text is cached per-entry and fully indexed, so you can search for words that only exist inside a photograph, screenshot, or scan. The top 12 QA results also trigger background OCR warm-up if the entry hasn't been processed yet — it all happens silently.
Typeahead search & query history Plus
As you type in the main search bar, real-time dropdown suggestions appear — matching titles, details, labels, attachment names, and content. Your past queries are remembered so you can recall previous searches with a single tap.
✍️
Writing & Editing
Rich text editor Plus
A full contenteditable editor with: bold, italic, underline, strikethrough, ordered & unordered lists, headings H1–H6, font family selector, case transformation (UPPER, lower, Title, Sentence), text color & highlight pickers, tables with a visual size picker and right-click context menu for row/column operations, code blocks with language labels, callout blocks with accent bars, inline images, links, and built-in Markdown rendering via marked.js.
Sections — sub-entries within a note Plus
Break long notes into collapsible accordion sections. Each section has its own title, rich text body, and dedicated file attachments. Clip count badges show how many files each section holds. Sections are ideal for research papers, project phases, or any note that benefits from internal structure.
Entry fields — every property at your fingertips Plus
Every entry carries: title, body (rich text or plain), labels, page path (hierarchical placement), attachments (per-entry and per-section), sections, favorite toggle, protected/encrypted status, due date, expiry date, repeat/recurrence, and automatic created/updated timestamps. Every field is searchable and filterable.
Version history — 60-day snapshots Pro
Every edit creates a version snapshot stored in the /versions directory with 60-day retention. Browse your history in a modal sorted from newest to oldest, and restore any previous state with one click. Access history from the ⏳ button on any entry card.
Smart label suggestions Plus
While editing, VaultBook analyzes your content and suggests relevant labels as pastel-colored chips with counts. One click to apply — it speeds up tagging without interrupting your writing flow.
📂
Organization
Hierarchical pages — unlimited nesting Plus
Create a page tree with unlimited parent/child nesting, disclosure arrows, drag-and-drop reordering, page icons, color dots, right-click context menus (rename, delete, move), and activity-based sorting. An "All Pages" root view lets you see everything at once.
Labels, hashtags & favorites Plus
Labels are color-coded pill tags in the sidebar — click to filter. Inline #hashtags in note content auto-generate Kanban columns in the board tool. Favorites (star toggle) get a dedicated quick-access panel in the sidebar with a compact scrollable list.
Multi-tab views Pro
Open multiple independent entry list tabs at once. Each tab maintains its own sort, filter, pagination, and view state. The tab strip includes a + button to add new views — perfect for comparing research across different pages or labels.
Advanced filters & sorting Pro
Filter by file type (match any or match all), date field, and date range (any, 7 days, 30 days). Combine filters freely. Sort by multiple fields with a dropdown and toggle ascending/descending.
🔐
Security & Encryption
AES-256-GCM per-entry encryption Plus
Each protected entry is encrypted independently with AES-256-GCM. Key derivation uses PBKDF2 with 100,000 iterations of SHA-256. Every encryption generates a unique random 16-byte salt and 12-byte IV. Each entry has its own password — compromising one never exposes the rest. Decrypted plaintext is held in memory only and never written to disk.
Lock screen Plus
Activate the lock and the entire app blurs behind a full-page overlay. All pointer events and text selection are blocked — nothing is visible or interactable until you authenticate. Walk-away protection for shared environments.
Zero network architecture Plus
VaultBook has no backend, no API calls, no telemetry, no analytics pings. It runs entirely in your browser from a local HTML file. No data ever travels over a network connection. Your documents stay on your device, period.
🛠️
Built-in Tools
Kanban Board — labels & hashtags to columns Pro
Auto-generates drag-and-drop columns from your labels and inline #hashtags. Cards stay synced with your notes — move a card and the entry updates, edit a note and the board reflects it.
File Analyzer — visualize CSV/TXT data Pro
Drop a CSV or TXT file and instantly see your data analyzed and visualized. Ideal for quick data exploration without leaving your workspace.
RSS / Atom Reader Pro
Follow feeds organized in folders. Stay current with blogs, news, and publications — all inside VaultBook without opening another app.
Threads — chat-style notes Pro
A centered overlay for rapid-fire, chat-style note capture. Great for brainstorms, meeting notes, and stream-of-consciousness writing.
Save URL → Entry Pro
Paste any web page URL and VaultBook creates a searchable note from it. Capture articles, references, and bookmarks directly into your library.
MP3 Cutter & Joiner Pro
Trim silence, cut clips at precise points, and join multiple audio segments — all processed locally in your browser.
PDF Merge, Split & Compress Pro
Combine multiple PDFs into one, split a PDF into individual pages, or compress scanned documents to reduce file size — no upload to any server.
File & Media Explorers Pro
Browse all attachments by type, entry, or page in the File Explorer. The Photo & Video Explorer lets you scan folders of media for a visual gallery experience.
Folder Analyzer, Password Generator & Obsidian Import Pro
Folder Analyzer visualizes disk space and file sizes at a glance. Password Generator creates strong passwords and copies with one click. Import from Obsidian lets you drop .md files to migrate notes instantly.
📎
Files & Deep Indexing
Attachment management Plus
Attach files to entries and to individual sections within entries. All files are stored via the File System Access API in the /attachments directory with a JSON manifest (index.txt). Right-click context menus, pending/failed state indicators, and a reindex button (♻️) to rebuild the index at any time.
Deep file indexing — XLSX, PPTX, PDF, ZIP, MSG Pro
Pro unlocks deep text extraction from: XLSX/XLSM (SheetJS), PPTX slides (JSZip), PDF text layers (pdf.js), ZIP archive contents, and MSG Outlook emails (subject, from, body + nested attachments). All extracted text is indexed for search. Background warm-up ensures top results have their attachment text ready before you even scroll.
OCR of embedded images in documents Pro
Pro goes beyond inline OCR — it extracts and OCR's images inside other file formats: images within ZIP archives, rendered PDF pages (scanned document support), embedded images inside DOCX (word/media/*), and embedded images inside XLSX (xl/media/*). If there's text in an image buried inside a document, VaultBook will find it.
📅
Scheduling & Analytics
Timetable — day & week calendar Pro
A full calendar with tabbed day and week views over a scrollable 24-hour timeline. Task scheduling and prompts integrate with AI suggestions (upcoming entries in the next 48 hours). All data is persisted to disk so your schedule survives refreshes and sessions.
Sidebar time tabs — Recent, Due, Expiring Plus
The sidebar always shows three time-oriented tabs: Recent (recently modified entries), Due (upcoming due dates), and Expiring (approaching expiry). A fourth Tools tab gives quick access to all built-in tools.
Analytics charts & insights Pro
Three Canvas-rendered charts: label utilization pie chart, last 14 days activity line chart, and pages utilization pie. Plus attachment type breakdown chips and inline metric pills for entry counts, file counts, and total storage size — all computed locally.
Random note spotlight & tickers Pro
The 🎲 sidebar widget surfaces a random note every hour with a "new pick" indicator — a gentle way to rediscover forgotten ideas. Companion widgets show a timetable ticker (upcoming events) and attachment ticker (recent file activity).
Under the hood
How VaultBook stores your world
No server, no database, no runtime. Just plain files in a folder you own.
🌐
Browser
Chrome / Edge / Brave / Arc
→
📄
VaultBook.html
Single-file application
→
📂
Your Folder
File System Access API
📁 my-vault/
├─ license.json
├─ repository.json ← pages, entries, votes
├─ 📁 attachments/
│ ├─ index.txt ← manifest
│ ├─ details-abc123.md ← sidecar body
│ └─ report.pdf
└─ 📁 versions/ ← 60-day snapshots
├─ license.json
├─ repository.json ← pages, entries, votes
├─ 📁 attachments/
│ ├─ index.txt ← manifest
│ ├─ details-abc123.md ← sidecar body
│ └─ report.pdf
└─ 📁 versions/ ← 60-day snapshots
Choose your tier
Plus vs Pro — at a glance
Both tiers include the full offline workspace. Pro unlocks advanced AI, tools, and deep indexing.
Plus
VaultBook Plus
$49 / year
AI suggestions & sparkle pager
Natural-language QA search
Inline OCR & typeahead
Rich text editor & sections
Hierarchical pages & labels
AES-256-GCM encryption
Attachments & basic indexing
Sidebar time tabs & basic analytics
Lock screen & autosave
Pro
VaultBook Pro
$79 / year
Everything in Plus
Vote-based reranking & learning
Related entries with training
Multi-tab views & advanced filters
Version history (60-day snapshots)
Deep indexing: XLSX, PPTX, PDF, ZIP, MSG
OCR inside documents (DOCX, XLSX, PDF, ZIP)
12+ built-in tools (Kanban, PDF, RSS…)
Timetable, charts & random spotlight
Ready to get started?
Download VaultBook, open it in your browser, and start writing — in under a minute.