Vaultr: The Simplest Way to Build AI Workflows Around Your Notes.

中文文档

Table of Contents

• Highlight Features
• Design
• Architecture
• Installation
• Obsidian Compatibility
• Editor
• Shorts
• Mate Bots
• WeChat
• Discord
• LLM-Wiki Compiler
• Personal Memory
• Skills (full guide)
• Customizing AI Behavior
• Shortcuts

Highlight Features

📝 Full-Featured Note System

• Built-in WYSIWYG editor: write in rich text or raw Markdown, switch anytime
• Wikilinks and wiki images: fully Obsidian-compatible
• Shorts: a daily capture stream for quick notes, accessible from anywhere
• Instant search inspired by Raycast: find anything as you type
• Clip browser extension: save any webpage as Markdown with one click
• Can also be self-hosted on a remote server

🤖 Event-Driven Multi-Agent System

• 15 agent CLIs supported out of the box
• Event-triggered automation: agents run tasks automatically when notes change, messages arrive, or schedules fire
• WeChat & Discord integration: chat with agents directly from WeChat or Discord DMs

🧠 LLM-Wiki Compiler

• Compiles your notes into structured knowledge and builds an interconnected LLM wiki network

🪞 Personal Memory

• Automatically extracts personal memories from your notes (identity, preferences, goals, beliefs, people, and current state) into structured files that stay current
• Lets your AI agents truly know you: every conversation carries memory instead of starting cold

🔒 Local-First, Fully Offline

• All your data lives on your own machine: Markdown files, SQLite metadata, full-text index
• The desktop app bundles every dependency: no CDN, no cloud account, no internet required

🌐 Multiple Access Channels

• Available via CLI, desktop app, WeChat, and Discord

Design

Vaultr has one core idea: let AI organize your notes, not you.

Write freely, don't manage

Vaultr discourages spending energy on note maintenance: elaborate categorization, nested folder hierarchies, manual tagging, and archiving. These are low-value, repetitive chores. Taking notes should be effortless and spontaneous: just write.

Concretely, Vaultr strongly discourages nested directories. You can create simple buckets like /reading, /work, or /ideas, but nesting subdirectories inside them is not recommended, though it's technically possible. Keeping things flat frees you from the mental overhead of deciding where every note belongs.

AI compiles, you don't organize

What turns raw notes into useful knowledge? Vaultr's answer: hand it off to AI.

• You write short notes, journal entries, clip web pages. No curation needed.
• AI agents automatically compile these notes into structured knowledge, building an interconnected LLM wiki network in the knowledge base
• The knowledge base is further distilled into personal memory, giving every conversation context

The entire pipeline runs automatically. You don't need to be involved in any organizing work.

AI retrieves, you don't browse

Vaultr ships full-text search, but the more important capability is letting agents retrieve on your behalf. When you need something, ask an agent directly. It searches your notes and knowledge base and surfaces the answer.

⚠️ Things you must know before using Vaultr

• Avoid nested directories. Vaultr recommends a flat, single-level directory structure. You can technically create subdirectories inside category folders, but it is strongly discouraged.
• Keep filenames unique. Vaultr links notes using Wiki Link syntax [[stem]], by filename rather than path. Duplicate filenames cause ambiguous references.
• Underscore-prefixed directories are system-reserved. Directories like _knowledge/, _shorts/, and _memory/ are used internally by Vaultr. Do not use an underscore prefix for your own category directories.
• Vaultr does not bundle an AI Agent. You need an agent CLI already installed on your machine (e.g. Claude Code, OpenCode, Codex). Vaultr discovers them automatically from your PATH with no extra configuration needed. See Backing Agents.

Architecture

┌──────────────┐  ┌──────────────┐  ┌──────────────┐  ┌──────────────┐
│              │  │              │  │              │  │              │
│  Desktop App │  │    WeChat    │  │     CLI      │  │  Clip (Ext)  │
│              │  │              │  │              │  │              │
└──────┬───────┘  └──────┬───────┘  └──────┬───────┘  └──────┬───────┘
       │                 │                 │                 │
       └─────────────────┴─────────────────┴─────────────────┘
                                  │
                                  ▼
┌────────────────────────────────────────────────────────────────────┐
│                           Vaultr Server                            │
└──────┬─────────────────┬─────────────────┬─────────────────┬───────┘
       │                 │                 │                 │
       ▼                 ▼                 ▼                 ▼
┌──────────────┐  ┌──────────────┐  ┌──────────────┐  ┌──────────────┐
│  Filesystem  │  │    SQLite    │  │    Bleve     │  │    Agents    │
│   (Markdown) │  │  (Metadata)  │  │  (FTS Index) │  │  (CLI/MCP)   │
└──────────────┘  └──────────────┘  └──────────────┘  └──────────────┘

Vaultr Server is a single, self-contained Go binary with no external dependencies. It embeds SQLite and Bleve directly, so the entire server is just one executable you drop anywhere and run.

Because it's a plain HTTP server, it deploys equally well on your local machine or a remote cloud instance. Run it on a home server or a container; all clients (desktop app, CLI, WeChat bridge) connect over the network the same way.

Installation

For most users: install the Desktop App and the Clip extension — that's it. The Desktop App detects the CLI on first launch and offers one-click installation if it is not found. A standalone Server & CLI installation is only needed if you want to deploy Vaultr on a remote or headless host.

💻 Desktop App

1. Download the latest .dmg file from the Latest Release page

2. Open the dmg and drag Vaultr into your Applications folder

3. On first launch, macOS may block the app since it is signed but not notarized by Apple

   Fix: Go to System Settings → Privacy & Security, scroll down to find the blocked app notice, and click Open Anyway

4. The Desktop App installs the vaultr CLI to ~/.local/bin/vaultr. Add this to your shell profile so agents can use it:

   # zsh — add to ~/.zshrc or ~/.zprofile
   export PATH="$HOME/.local/bin:$PATH"
   
   # bash — add to ~/.bash_profile or ~/.bashrc
   export PATH="$HOME/.local/bin:$PATH"
   

   Restart your terminal (or run source ~/.zshrc / source ~/.bash_profile) afterward.

🧩 Browser Extension (Clip)

1. Download the latest vaultr-clip-*.zip from the Latest Release page
2. Unzip the file
3. Open Chrome or Edge and go to chrome://extensions/
4. Enable Developer mode in the top-right corner
5. Click Load unpacked and select the unzipped folder
6. The extension is now installed and visible in your browser toolbar

⌨️ Server & CLI

Run the following command to install the Vaultr server and CLI:

curl -sL https://raw.githubusercontent.com/skoowoo/vaultr-notes/main/install-cli.sh | sh

Obsidian Compatibility

Vaultr is fully compatible with Obsidian. Both tools can work on the same vault at the same time, no migration required, no need to pick one over the other.

• Same vault, same files. Vaultr reads and writes plain Markdown in your existing directory structure. Keep using Obsidian as your primary editor if you prefer.
• Obsidian-native syntax. Wikilinks ([[Note]]), aliases ([[Page|Alias]]), and wiki images (![[image.png]]) all work out of the box.
• No format conversion. Everything Vaultr creates or modifies stays standard Markdown — open it in Obsidian and it looks exactly as you'd expect.
• Vaultr as your AI layer. Point Vaultr at your Obsidian vault and let it handle the AI side: LLM wiki compilation, personal memory, event-driven agents, WeChat, and search. You write in Obsidian; Vaultr runs the automation on top.

Get started with an existing vault

Point vaultr init at your Obsidian vault directory:

# Initialize the current directory
vaultr init

# Or pass a path explicitly
vaultr init /path/to/your/obsidian-vault

This creates a .vaultr/ folder inside the directory, scans all Markdown files, registers them in the metadata database, and builds the full-text search index. If .vaultr/ already exists the command exits safely without changing anything. Your Obsidian vault is otherwise untouched.

After running vaultr init, open the Vaultr desktop app and complete the setup:

1. Go to Settings → Server → Config
2. Under Vault, click the path field and select your vault directory
3. Save config

Your notes will now be available in Vaultr — while Obsidian continues to work on the same vault as before.

Editor

Vaultr includes a built-in WYSIWYG Markdown editor. Notes open in rich-text mode by default; toggle to raw Markdown at any time with the mode button in the toolbar.

✍️ Writing

The editor supports