Documentation

Everything you need to get started with BrainVault.

Getting Started

  1. Install BrainVault from the download page
  2. Launch the app - no signup required
  3. Create a note: Cmd/Ctrl+N or click "New Note"
  4. Write in Markdown: Headings with #, lists with -, code with backticks
  5. Link notes: [[Note Name]] creates bidirectional links
  6. Search: Cmd/Ctrl+K to find anything instantly
  7. View graph: See your knowledge network in 3D

Keyboard Shortcuts

Cmd/Ctrl + NNew Note
Cmd/Ctrl + KQuick Search
Cmd/Ctrl + SSave (auto-saves anyway)
Cmd/Ctrl + EToggle Editor/Preview
Cmd/Ctrl + BBold text
Cmd/Ctrl + IItalic text
Cmd/Ctrl + LInsert link
Cmd/Ctrl + GOpen graph view

Import & Export

Importing Notes

  • From Obsidian: Point BrainVault to your Obsidian vault folder. Links work immediately.
  • From Notion: Export as Markdown & CSV, then import folder into BrainVault.
  • From Roam/Logseq: Export as Markdown, adjust links if needed.
  • From plain files: Just copy .md files into your BrainVault folder.

Exporting Notes

  • Markdown: File > Export > Markdown (creates .zip of all notes)
  • PDF: File > Export > PDF (single note or entire vault)
  • Manual: Your notes are already Markdown files in your chosen folder

Frequently Asked Questions

How do I create my first note?

Press Cmd/Ctrl+N or click the "New Note" button. Start typing in Markdown. BrainVault auto-saves as you write.

How do wiki links work?

Type [[note name]] to create a link to another note. If the note doesn't exist, it will be created when you click the link.

Can I sync notes across devices?

Use any file sync tool (Git, Dropbox, Syncthing, iCloud Drive, OneDrive). Point all devices to the same notes folder.

How do I export my notes?

File > Export > Choose format (Markdown ZIP, PDF, or individual files). Your notes are already plain Markdown, so they're always portable.

Does BrainVault support tags?

Use hashtags in your notes: #project #idea. Search will find them instantly.

Need More Help?

Check out our GitHub repository for more documentation, or open an issue if you find a bug.

Visit GitHub →