Skip to main content

Vault Assistant Documentation

Welcome to the Vault Assistant documentation. This guide details how the application works, how to configure its features, and how to contribute to its development.

Getting started​

  • Introduction : Overview of the project, capabilities, and quick startup.
  • Installation : Installing from npm, downloading the desktop app, or running from source.
  • System prerequisites : Required tools, optional engine CLIs, and desktop build dependencies.

Interfaces​

  • Web interface : The default frontend, with tabs, split view, quick notes, and keyboard shortcuts.
  • Desktop app (Tauri) : The same interface in a native window, with a bundled runtime.
  • Terminal interface (TUI) : The full workflow from a terminal, and how it differs from the web interface.

Application features​

  • Ask mode : Asking grounded questions, generation toggles, and the answer area.
  • Draft mode : Drafting first-person text from a job description and attached documents.
  • Write to vault : Auto-placing notes, scanning vault gaps, proposing document writes, and the write approval flow.
  • RAG retrieval : Local BM25 indexing, token optimization, and context selection.
  • Local web research : Integrating SearXNG, crawler resolution modes, and IP security checks.
  • Custom skills : Skill directories, YAML formatting rules, and the interactive skill generator.
  • Settings panel features : Page list, folder validators, skill creators, and color appearance sliders.

Technical architecture​