siyuan-note

Manage SiYuan notes and documents via API with SQL queries.

3|1|Updated Feb 2, 2026
One-click install
npx skills add https://github.com/sunchendd/good_skills --skill siyuan-note
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan-note
Source: https://github.com/sunchendd/good_skills/tree/main/siyuan-note
Command: npx skills add https://github.com/sunchendd/good_skills --skill siyuan-note

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Efficiently manage a personal knowledge base with SiYuan Note via API by performing CRUD operations on notes and documents, searching content with SQL, and organizing notebooks, blocks, and assets.

Core Features & Use Cases

  • Create, read, update, and delete notes and documents via the SiYuan API.
  • Search and query content using SQL across notebooks and blocks.
  • Export documents or resources and manage notebooks and file structure.
  • Use Case: Build a centralized knowledge base by aggregating notes from multiple notebooks and exporting summaries.

Quick Start

Configure SIYUAN_HOST and SIYUAN_TOKEN environment variables, then use the SiYuan API helper to manage notebooks and documents.

Frequently Asked Questions about siyuan-note

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I manage SiYuan notes via API to create and update documents?

Manage SiYuan notes via API by configuring the SIYUAN_HOST and SIYUAN_TOKEN environment variables to authenticate requests. You can then perform create, read, update, and delete operations on notes and documents by calling the bundled Python script to execute API endpoints.

Can I query SiYuan notebook content using SQL?

Query SiYuan notebook content using SQL to search and filter across blocks and documents. The API integration supports executing SQL statements directly, allowing you to retrieve specific content blocks and aggregate notes from multiple notebooks.

What do I need to run SiYuan API commands for knowledge base management?

To run SiYuan API commands for knowledge base management, you need a running SiYuan instance at the configured host and a valid API token. Set the SIYUAN_HOST and SIYUAN_TOKEN environment variables to authorize the bundled Python script.

Does the SiYuan API support exporting documents and managing resources?

The SiYuan API supports exporting documents or resources and managing notebooks and file structure. You can organize blocks, manage assets, and export summaries to build a centralized knowledge base by calling the relevant API endpoints.

How to organize blocks and notebooks in a SiYuan knowledge base?

Organize blocks and notebooks in a SiYuan knowledge base by using the API to structure documents and manage file hierarchies. The integration allows you to create, update, and delete blocks while searching content with SQL to maintain organization.