A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang.
Subagents45.3k stars2.9k forks● TypeScriptAGPL-3.0Updated today
Install as a Claude Code subagent
Method: Clone
Terminal
git clone https://github.com/siyuan-note/siyuan && cp siyuan/*.md ~/.claude/agents/1. Clone the repository and copy the agent .md definitions into ~/.claude/agents (or .claude/agents inside a project).
2. Start a new Claude Code session to load the agents.
3. Delegate work to them with the Task/Agent tool or by name.
Use cases
About
Subagents overview
<p align="center"> <img alt="SiYuan" src="https://b3log.org/images/brand/siyuan-128.png"> <br> <em>Refactor your thinking</em> <br><br> <a title="Build Status" target="_blank" href="https://github.com/siyuan-note/siyuan/actions/workflows/cd.yml"><img src="https://img.shields.io/github/actions/workflow/status/siyuan-note/siyuan/cd.yml?style=flat-square"></a> <a title="Releases" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/release/siyuan-note/siyuan.svg?style=flat-square&color=9CF"></a> <a title="Downloads" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/downloads/siyuan-note/siyuan/total.svg?style=flat-square&color=blueviolet"></a> <br> <a title="Docker Pulls" target="_blank" href="https://hub.docker.com/r/b3log/siyuan"><img src="https://img.shields.io/docker/pulls/b3log/siyuan.svg?style=flat-square&color=green"></a> <a title="Docker Image Size" target="_blank" href="https://hub.docker.com/r/b3log/siyuan"><img src="https://img.shields.io/docker/image-size/b3log/siyuan.svg?style=flat-square&color=ff96b4"></a> <a title="Hits" target="_blank" href="https://github.com/siyuan-note/siyuan"><img src="https://hits.b3log.org/siyuan-note/siyuan.svg"></a> <br> <a title="AGPLv3" target="_blank" href="https://www.gnu.org/licenses/agpl-3.0.txt"><img src="http://img.shields.io/badge/license-AGPLv3-orange.svg?style=flat-square"></a> <a title="Code Size" target="_blank" href="https://github.com/siyuan-note/siyuan"><img src="https://img.shields.io/github/languages/code-size/siyuan-note/siyuan.svg?style=flat-square&color=yellow"></a> <a title="GitHub Pull Requests" target="_blank" href="https://github.com/siyuan-note/siyuan/pulls"><img src="https://img.shields.io/github/issues-pr-closed/siyuan-note/siyuan.svg?style=flat-square&color=FF9966"></a> <br> <a title="GitHub Commits" target="_blank" href="https://github.com/siyuan-note/siyuan/commits/master"><img src="https://img.shields.io/github/commit-activity/m/siyuan-note/siyuan.svg?style=flat-square"></a> <a title="Last Commit" target="_blank" href="https://github.com/siyuan-note/siyuan/commits/master"><img src="https://img.shields.io/github/last-commit/siyuan-note/siyuan.svg?style=flat-square&color=FF9900"></a> <br><br> <a title="Twitter" target="_blank" href="https://twitter.com/b3logos"><img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/b3logos?label=Follow&style=social"></a> <a title="Discord" target="_blank" href="https://discord.gg/dmMbCqVX7G"><img alt="Chat on Discord" src="https://img.shields.io/discord/808152298789666826?label=Discord&logo=Discord&style=social"></a> <br><br> <a href="https://trendshift.io/repositories/3949" target="_blank"><img src="https://trendshift.io/api/badge/repositories/3949" alt="siyuan-note%2Fsiyuan | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a> </p> <p align="center"> <b>English</b> | <a href="README.zh-CN.md">中文</a> | <a href="README.ja.md">日本語</a> | <a href="README.tr.md">Türkçe</a> </p> --- ## Table of Contents - [💡 Introduction](#-introduction) - [🔮 Features](#-features) - [🏗️ Architecture and Ecosystem](#-architecture-and-ecosystem) - [🗺️ Roadmap](#️-roadmap) - [🚀 Download Setup](#-download-setup) - [App Market](#app-market) - [Installation Package](#installation-package) - [Package Manager](#package-manager) - [Docker Hosting](#docker-hosting) - [Unraid Hosting](#unraid-hosting) - [TrueNAS Hosting](#truenas-hosting) - [Insider Preview](#insider-preview) - [⌨️ Command-line Interface](#-command-line-interface) - [🏘️ Community](#️-community) - [🛠️ Development Guide](#️-development-guide) - [❓ FAQ](#-faq) - [How does SiYuan store data?](#how-does-siyuan-store-data) - [Does it support data synchronization through a third-party sync disk?](#does-it-support-data-synchronization-through-a-third-party-sync-disk) - [Is SiYuan open source?](#is-siyuan-open-source) - [How to upgrade to a new version?](#how-to-upgrade-to-a-new-version) - [What if some blocks (such as paragraph blocks in list items) cannot find the block icon?](#what-if-some-blocks-such-as-paragraph-blocks-in-list-items-cannot-find-the-block-icon) - [What should I do if the data repo key is lost?](#what-should-i-do-if-the-data-repo-key-is-lost) - [Do I need to pay for it?](#do-i-need-to-pay-for-it) - [🙏 Acknowledgement](#-acknowledgement) - [Contributors](#contributors) --- ## 💡 Introduction SiYuan is a privacy-first personal knowledge management system, supporting fine-grained block-level reference and Markdown WYSIWYG. Welcome to [SiYuan English Discussion Forum](https://liuyun.io) to learn more. Online user guide: [English](https://siyuan-en.b3log.org/)   ## 🔮 Features Most features are free, even for commercial use. - Content block - Block-level reference and two-way links - Custom attributes - SQL query embed - Protocol `siyuan://` - Editor - Block-style - Markdown WYSIWYG - List outline - Block zoom-in - Million-word large document editing - Mathematical formulas, charts, flowcharts, Gantt charts, timing charts, staves, etc. - Web clipping - PDF Annotation link - Export - Block ref and embed - Standard Markdown with assets - PDF, Word and HTML - Copy to WeChat MP, Zhihu and Yuque - Database - Table view - Flashcard spaced repetition - AI writing and Q/A chat via OpenAI API - Tesseract OCR - Multi-tab, drag and drop to split screen - Template snippet - JavaScript/CSS snippet - Android/iOS/HarmonyOS App - Docker deployment - [API](https://github.com/siyuan-note/siyuan/blob/master/docs/API.md) - Community marketplace Some features are only available to paid members, for more details please refer to [Pricing](https://b3log.org/siyuan/en/pricing.html). ## 🏗️ Architecture and Ecosystem  | Project | Description | Forks | Stars | |----------------------------------------------------------|-----------------------|---------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| | [lute](https://github.com/88250/lute) | Editor engine |  |  | | [chrome](https://github.com/siyuan-note/siyuan-chrome) | Chrome/Edge extension |  |  | | [bazaar](https://github.com/siyuan-note/bazaar) | Community marketplace |  |  | | [dejavu](https://github.com/siyuan-note/dejavu) | Data repo |  |  | | [petal](https://github.com/siyuan-note/petal) | Plugin API |  |  | | [android](https://github.com/siyuan-note/siyuan-android) | Android App |  |  | | [ios](https://github.com/siyuan-note/siyuan-ios) | iOS App |  |  | | [harmony](https://github.com/siyuan-note/siyuan-harmony) | HarmonyOS App |  |  | | [riff](https://github.com/siyuan-note/riff) | Spaced repetition |  |  | ## 🗺️ Roadmap - [SiYuan development plan and progress](https://github.com/orgs/siyuan-note/projects/1) - [SiYuan changelog](CHANGELOG.md) ## 🚀 Download Setup It is recommended to give priority to installing through the application market on desktop and mobile, so that you can upgrade the version with one click in the future. ### App Market Mobile: - [App Store](https://apps.apple.com/us/app/siyuan/id1583226508) - [Google Play](https://play.google.com/store/apps/details?id=org.b3log.siyuan) - [F-Droid](https://f-droid.org/packages/org.b3log.siyuan) Desktop: - [Microsoft Store](https://apps.microsoft.com/detail/9p7hpmxp73k4) ### Installation Package - [B3log](https://b3log.org/siyuan/en/download.html) - [GitHub](https://github.com/siyuan-note/siyuan/releases) ### Package Manager #### `siyuan` [](https://repology.org/project/siyuan/versions) #### `siyuan-note` [](https://repology.org/project/siyuan
Topics
agentic-aiai-agentdigital-gardenelectronknowledge-baseknowledge-graphlocal-firstmarkdownmcpnote-takingnotebooknotes-apppdfpkms3self-hostedsiyuanwebdavwiki
Frequently asked
What people ask about siyuan
What is siyuan-note/siyuan?
+
siyuan-note/siyuan is subagents for the Claude AI ecosystem. A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang. It has 45.3k GitHub stars and was last updated today.
How do I install siyuan?
+
You can install siyuan by cloning the repository (https://github.com/siyuan-note/siyuan) or following the README instructions on GitHub. ClaudeWave also provides quick install blocks on this page.
Is siyuan-note/siyuan safe to use?
+
siyuan-note/siyuan has not been audited yet by our security agent. Review the original repository on GitHub before using it in production.
Who maintains siyuan-note/siyuan?
+
siyuan-note/siyuan is maintained by siyuan-note. The last recorded GitHub activity is from today, with 286 open issues.
Are there alternatives to siyuan?
+
Yes. On ClaudeWave you can browse similar subagents at /categories/agents, sorted by popularity or recent activity.
1-click deploy
Deploy siyuan to your cloud
Ship this repo to production in minutes. Each platform spins up its own environment with editable env vars.
Embeddable badge
Maintain this repo? Add a badge to your README
Drop the badge into your GitHub README to show it's tracked on ClaudeWave. Each badge links back to this page and reflects the live Trust Score.
[](https://claudewave.com/repo/siyuan-note-siyuan)<a href="https://claudewave.com/repo/siyuan-note-siyuan"><img src="https://claudewave.com/api/badge/siyuan-note-siyuan" alt="Featured on ClaudeWave: siyuan-note/siyuan" width="320" height="64" /></a>Related
More Subagents
affaan-m
ECC
today
The agent harness performance optimization system. Skills, instincts, memory, security, and research-first development for Claude Code, Codex, Opencode, Cursor and beyond.
231.9k35.4kJavaScript
Subagentsai-agentsanthropicInstall
NousResearch
hermes-agent
today
The agent that grows with you
218.5k41.3kPython
Subagentsaiai-agentInstall
Snailclimb
JavaGuide
today
Java 面试 & 后端通用面试指南，覆盖计算机基础、数据库、分布式、高并发、系统设计与 AI 应用开发
157.2k46.2kJavaScript
SubagentsagentaiInstall
langgenius
dify
today
Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.
149.7k23.6kTypeScript
Subagentsagentagentic-aiInstall
langchain-ai
langchain
today
The agent engineering platform.
142.3k23.7kPython
SubagentsagentsaiInstall
Graphify-Labs
graphify
today
Turn any codebase, with its docs, SQL schemas, configs, and PDFs, into a queryable knowledge graph. A /graphify skill for Claude Code, Cursor, Codex, and Gemini CLI: local deterministic AST parsing, every edge explained, no vector store.
93.2k9kPython
Subagentsai-agentsantigravityInstall