Skip to content

Repository files navigation

OpenSidian logo

OpenSidian

Accumulate knowledge that is yours.
When AI can do almost anything, your lived experience, taste, and judgment are the last moat. OpenSidian is a local-first knowledge app built to last.

Website · Try Web App · Docs · 简体中文

License: AGPL-3.0 Website Web App


Why OpenSidian

OpenSidian is a local-first knowledge app built around three simple beliefs: more timeless, safer & more open, and more AI.

All notes live as plain Markdown in open folders—readable and writable across tool generations. Data stays on your device by default, with end-to-end encryption and an open ecosystem, so your knowledge is not locked into any commercial stack. Let AI sharpen your thinking: review material, connect threads, challenge assumptions, and expand ideas.

Try it in 30 seconds

No install required—run in the browser (data stays in your device OPFS):

https://webapp.osd.pub/

Desktop / Android builds: Download · GitHub Releases

Highlights

  • Workspace you already know — file tree, tabs, splits, Live Preview, graph, search, backlinks
  • Knowledge network[[wiki-links]], outline, Bases, Canvas
  • Plugins — core plugins + Obsidian-compatible community API (phased)
  • Optional AI (BYOK) — read tools + proposed edits; writes only after you confirm
  • Self-host & shareopensidian-server, Web Share snapshot links, pure browser Web App

Stack

Rust · Tauri v2 · React · TypeScript · CodeMirror 6 · HeroUI

React UI / CodeMirror ──typed IPC──► Tauri ──► opensidian-core ──► filesystem

Quick start (developers)

pnpm install
pnpm dev          # native desktop window (macOS)
pnpm dev:webapp   # browser Web App locally

More: Build guide · AGENTS.md · docs/INDEX.md

Repository map

apps/desktop/            # Tauri v2 + React shell
crates/opensidian-core/  # Vault / index / graph (no UI)
packages/                # editor · ipc-types · plugin-api · …
plugins/                 # built-in plugins
services/                # Web Share · Web App deploy
docs/site/               # public docs (VitePress, zh/en)

License

Licensed under the GNU Affero General Public License v3.0 (AGPL-3.0-only).

If you modify OpenSidian and offer it as a network service, you must make the corresponding source available under AGPL.

Links

Website osd.pub
Web App demo webapp.osd.pub
Why we build this Why OpenSidian
Feature list Features
中文说明 README.zh-CN.md

OpenSidian is not affiliated with Obsidian. We align with workspace UX and public APIs; we do not reverse-engineer closed-source code or implement Obsidian Sync / Publish.

About

OpenSidian is a local-first knowledge app built around three simple beliefs: more timeless , safer & more open , and more AI 。一个本地优先的知识管理应用,围绕三个简单的信念构建:更长远、更安全开放、更加 AI。

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages