# Project pack: SiYuan @ bfe3610

Facts about **SiYuan** for an AI following the [BespokeAI handover guide](https://handoff.bespokeai.software/guide/v4.md). Pinned to one version; never changes after publication.

> SiYuan is a notebook for your thoughts, journals, studies and plans. You write in a clean editor and can link or embed any paragraph from one note into another, so ideas connect up. It has daily notes, tables and card databases, flashcards for revision, PDF annotation and an optional AI helper. Notes stay in a folder on your own computer, with apps for desktop and phone, or a web version you run yourself.

## Setup path (checked 2026-11-03)
- **Start here, no Docker:** Install the project's own desktop app or installer. No Docker.
- Offer Docker only if the person asks or this path fails. The commands further down may use Docker; they are not the starting point.
- Verdict source: https://raw.githubusercontent.com/siyuan-note/siyuan/HEAD/README.md
- You may be unable to download source archives or run commands in this session. The person downloads and runs things; if you cannot fetch something, give any changed file in full in chat with its path.

## Version and source
- Repository: https://github.com/siyuan-note/siyuan
- Pinned commit: `bfe36100477b7bbd66db1a8b8cff5547b2ccdb59`. Use exactly this version.
- Zip the person can download in a browser: https://github.com/siyuan-note/siyuan/archive/bfe36100477b7bbd66db1a8b8cff5547b2ccdb59.zip
- Fresh checkout (only if you have a shell and git): use the commands below in an empty folder. If this exact source is already checked out, keep your branch and use the development command; do not clone again or reset local changes.
- Official docs: https://siyuan-en.b3log.org/
- Licence: **AGPL-3.0-or-later**. Free to use and change. If you run a changed version that other people use over the internet (not just you or your household), you must offer them your source code under the same licence. Private use has no extra obligations. Some features, such as SiYuan's cloud sync, need a paid membership.

## Commands from the pinned source
- Developer commands (they may use Docker):

  ```sh
  git clone https://github.com/siyuan-note/siyuan bespoke-siyuan
  cd bespoke-siyuan
  git checkout --detach bfe36100477b7bbd66db1a8b8cff5547b2ccdb59
  # Prepare development requirements and local configuration first.
  # Setup notes: then in app/: pnpm install && pnpm run install:electron && pnpm run dev && pnpm run start
  cd kernel && go build -tags "fts5 sqlcipher" -o ../app/kernel/SiYuan-Kernel && cd ../app/kernel && ./SiYuan-Kernel serve --mode=dev
  ```

- Separate trial of the current upstream release (not your changes; sample data and a separate data directory only):

  ```sh
  # Easiest: download the app for Windows, Mac, Linux, Android or iPhone from https://b3log.org/siyuan/en/download.html
  # Or run the web version in Docker, on this computer only:
  docker run -d --name siyuan -p 127.0.0.1:6806:6806 -v siyuan-workspace:/siyuan/workspace b3log/siyuan serve --workspace=/siyuan/workspace/ --accessAuthCode=choose-a-long-password
  # Then open http://localhost:6806 and enter that password.
  ```
- Tools these commands use: The desktop or phone app, or Docker for the web version (browser only; no PDF/Word export or Markdown import there), For development, Node 24 with pnpm (version in app/package.json) and Go (version in kernel/go.mod)
- Develop: `cd kernel && go build -tags "fts5 sqlcipher" -o ../app/kernel/SiYuan-Kernel && cd ../app/kernel && ./SiYuan-Kernel serve --mode=dev   # then in app/: pnpm install && pnpm run install:electron && pnpm run dev && pnpm run start`
- Test: `cd app && pnpm test   # Go kernel: targeted go test runs, e.g. cd kernel && go test ./apicontract/...`
- Check/lint: `cd app && pnpm run lint   # gofmt for Go changes`
- Build: `cd app && pnpm run build`
- Stack: go, typescript, javascript, css (Gin, Lute, Electron, webpack). Difficulty for a non-developer with an AI: **advanced**. Themes, CSS and JavaScript snippets, templates, plugins from the built-in marketplace and a full HTTP API let you change a lot without touching the code. The code itself is large and strict: a Go kernel plus a TypeScript front end (no framework) built with webpack, generated API contracts, and a detailed AGENTS.md with rules that agents must follow.
- The project's own AI instructions, in the repository: `AGENTS.md`, `.github/CONTRIBUTING.md`.
Personal data: **yes**. Stored in: A workspace folder: notes as .sy JSON files per notebook in workspace/data/, plus assets, templates, snippets, plugins and SQLite search indexes. In Docker, the mounted /siyuan/workspace volume. Secrets are entered by the person, never in chat.

---
Later, only when a step needs it: [reference.md](https://handoff.bespokeai.software/p/siyuan/bfe3610/r3/reference.md) (customisation points, must-keep-working, data and costs, coding conventions) · [hosting.md](https://handoff.bespokeai.software/p/siyuan/bfe3610/r3/hosting.md) (long-term hosting; hosts are paid third parties) · [bespoke.yaml](https://handoff.bespokeai.software/p/siyuan/bfe3610/r3/bespoke.yaml) · [SKILL.md](https://handoff.bespokeai.software/p/siyuan/bfe3610/r3/SKILL.md)