SoloMD

SoloMD

The editor where agents live.

🌐 中文 · 日本語 · 한국어 · Deutsch · Français · Español · Português · Italiano · Polski · Nederlands · Türkçe · Svenska · Українська · 🪞 Gitee mirror → (faster downloads from China)

Download v4.0 · Launch post · How we built it · Website · Security

Your notes live in a folder. SoloMD is the editor on top — with a first-class agent surface inside the editor, and the MCP endpoint Claude Code / Cursor can drive from outside. Same .md files. Chat with your vault. Schedule recipes that run when you're not at the keyboard. Hand the same vault to any MCP client.

Built on Tauri 2 + Vue 3 + CodeMirror 6. Universal macOS dmg ~32 MB. Free, MIT, no subscription, no SoloMD-hosted servers. Your notes, AI keys, embeddings index, and git history all stay on your machine.

Three halves of one product

The editor. WYSIWYG live edit (Typora-style), tabs + split panes, KaTeX + Mermaid, image paste to _assets/, slideshow mode (⌘⌥P), Vim mode, Hunspell + CJK proofread, semantic search (⌘⇧F), wikilinks + backlinks, Pandoc export. CJK encodings (GBK / Big5 / Shift-JIS) auto-detected.

The endpoint. A bundled solomd-mcp binary exposes the same vault to any MCP client — 13 tools out of the box, including 5 SoloMD-only ones (autogit_log, autogit_diff, autogit_rollback, sync_status, share_url) that no other markdown server has. v4.0 adds --workspace path1 --workspace path2 federation — one MCP session, many vaults. Plus a solomd agent <prompt> CLI that hands off to Claude Code / Codex CLI with the MCP pre-wired.

The agent surface (v4.0). Right-side Agent Panel: streamed chat-with-vault, [[wikilink]] citations, tool-call cards inline, Insert / Copy buttons drop the reply into the active note. Plus declarative recipes as YAML in <workspace>/.solomd/agents/*.yml — cron / on-save / on-commit / on-tag-add / manual triggers. Every agent write lands on its own AutoGit branch you accept or reject before it touches main; write-cap default 5; refuses to start when the working tree is dirty; replayable trace.jsonl per run with read_agent_trace MCP tool.

Use it

After installing SoloMD on macOS / Linux:

1. Chat with your vault. Open the right-side Agent Panel (⌘⇧P → "View: Toggle Agent Panel" if hidden). Streamed multi-turn against your notes; tool-call cards show every read/write inline. Reply too long? Insert drops it into the active note at the cursor (replaces selection); Copy to clipboard.

2. Schedule a recipe. Settings → Recipes → Browse cookbook. 11 starters ready: weekly review, daily summary, TODO extraction, translation pass, citation cleanup, CJK proofread agent, link-rot detector, frontmatter normalizer, outline-to-blog, refactor pass, weekly tag triage. Install one, edit the prompt, run it.

3. Drive the same vault from another LLM client. One-shot:

# Print the MCP config snippet for your AI client.
solomd mcp-config

{
  "mcpServers": {
    "solomd": {
      "command": "/Applications/SoloMD.app/Contents/Resources/solomd-mcp",
      "args": ["--workspace", "/Users/me/Documents/SoloMD"]
    }
  }
}

Paste into Claude Desktop / Cursor / etc. For multi-vault federation, repeat --workspace:

"args": [
  "--workspace", "/Users/me/Documents/SoloMD",
  "--workspace", "/Users/me/Documents/work-notes"
]

4. Or hand a prompt to claude / codex CLI directly:

solomd agent "rewrite this week of dailies into a weekly review and commit it"

Path-traversal guarded. No network port. The LLM only sees what you point the workspace at.

Install

Latest release: v4.0.0.

macOS — universal dmg (Apple Silicon + Intel, signed + notarized)

brew install --cask zhitongblog/solomd/solomd

Or download the dmg directly:

https://github.com/zhitongblog/solomd/releases/latest/download/SoloMD_4.0.0_universal.dmg

Or one-line shell install:

curl -fsSL https://solomd.app/install.sh | bash

Windows — x64

• SoloMD_4.0.0_x64_en-US.msi
• SoloMD_4.0.0_x64-setup.exe (NSIS)
• SoloMD_4.0.0_x64-portable.zip — no installer

irm https://solomd.app/install.ps1 | iex

winget install solomd

Linux — x86_64 + aarch64

• .AppImage (universal), .deb (Debian/Ubuntu), .rpm (Fedora/RHEL) — both architectures from the releases page.
• Arch users: solomd-bin on AUR.

iPad

App Store — same engine, native iPad UI.

Marketplaces & integrations

The bundled solomd-mcp server runs against any folder of Markdown files — you don't need to install SoloMD itself to drive your vault from Claude / Cursor / Cline / Continue / Zed. Install snippets for each:

Available as:

• Skill Pack — 11 reference Agent Recipes (weekly review, todo extract, link suggester, …) you can drop into <vault>/.solomd/agents/. Ships with every release.
• Claude Code Skill — SKILL.md + install.sh that wires solomd-mcp into ~/.claude/mcp.json and exposes the 13 tools to Claude Code with patterns and starter recipes.
• Smithery — smithery.yaml + Dockerfile at marketplace/smithery/ (submission pending).
• Awesome MCP Servers — PR entries for the three biggest community indices (punkpeye/, appcypher/, wong2/awesome-mcp-servers, ~14k forks combined) at marketplace/awesome-mcp/.

Full overview + submission status: marketplace/README.md.

Compared

Detailed breakdowns: vs Obsidian · vs Typora · vs Tolaria · vs Marktext.

Privacy & security

Pure client-side. Your .md files stay in the folder you chose. API keys live in the OS keychain (macOS Keychain / Windows Credential Manager / Linux libsecret), never in localStorage or any config file. AI requests go direct from your machine to the provider you picked — no SoloMD relay. RAG embeddings and the AutoGit repo are local-only. The MCP server speaks stdio, never opens a network port. The whole codebase is MIT and auditable.

Agent safety rails (v4.0). Every recipe run starts on its own AutoGit branch — your main stays untouched until you click Accept on the diff. Per-run write-cap (default 5, hard ceiling 50) prevents runaway loops. Recipe runner refuses to start when the working tree is dirty (no agent commit will ever sweep your work-in-progress). Path-traversal guards reject .. segments and absolute paths upfront in every Tauri / MCP / REST endpoint that accepts a user-supplied path.

E2EE sync uses Argon2id (RFC9106 default params) → XChaCha20-Poly1305 with deterministic nonces and path-as-AAD. Plaintext stays on your devices; the remote sees only ciphertext. Failed sync.json parsing is fail-closed — refuses to push rather than degrading to plaintext (a v3.0.x audit fix).

Full writeup: https://solomd.app/security.

Build from source

Prereqs: Rust (stable), Node 18+, pnpm.

git clone https://github.com/zhitongblog/solomd.git
cd solomd/app
pnpm install
pnpm tauri dev      # dev with hot reload
pnpm tauri build    # release artifacts → src-tauri/target/release/bundle/

Linux additionally needs libdbus-1-dev for the keychain backend.

The MCP server is a separate crate at mcp-server/; the dev MCP harness used for end-to-end testing lives at dev-mcp/. End-to-end test entry point: scripts/v4-self-test.sh (run with --with-release --with-ollama --with-ui for full coverage).

Contributing

Issues and PRs welcome — open one. For a sense of direction, see docs/roadmap.md. The v4.0 build log is at solomd.app/blog/v4-0-0-how-we-built-it/ — start there if you want to understand the engineering principles before sending a PR.

Contact / 联系

One maintainer, two front doors. Async on GitHub Discussions. Real-time chat:

• Telegram (international): @SOLOMDAPP — release announcements + chat
• WeChat (中文): scan to add me — note "SoloMD" 注明 SoloMD 直接通过

License & credits

MIT © 2026 xiangdong li. SoloMD stands on Tauri 2, Vue 3, CodeMirror 6, markdown-it, KaTeX, Mermaid, libgit2, Pandoc, Hunspell, keyring-rs, and rmcp. Sponsor on GitHub Sponsors or via solomd.app/#sponsor.