siyuan

Manage SiYuan Note blocks and documents via authenticated POST requests.

2|1|Updated Jul 14, 2026
One-click install
npx skills add https://github.com/heysuhas/hermes_cli --skill siyuan-heysuhas
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/heysuhas/hermes_cli/tree/main/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/heysuhas/hermes_cli --skill siyuan-heysuhas

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires curl, jq.

What problem does it solve?

This skill solves the friction of manually interacting with a self-hosted SiYuan knowledge base by providing a direct interface to perform CRUD operations on blocks and documents.

Core Features & Use Cases

  • Automated Knowledge Management: Programmatically search, create, update, and delete blocks or documents within your SiYuan instance.
  • Data Integration: Execute SQL queries against your knowledge base to retrieve specific information or generate reports.
  • Use Case: Automatically append daily meeting notes or sync external project tasks into your SiYuan workspace without opening the desktop application.

Quick Start

Use the siyuan skill to search for all blocks containing the keyword project and return the top five results.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I automate knowledge base management in SiYuan without opening the app?

You can automate SiYuan knowledge base management by executing authenticated POST requests via curl to interact with the API, allowing you to programmatically create, update, and delete blocks or documents.

Can I run SQL queries against my SiYuan notes to retrieve specific data?

Yes, you can execute SQL queries against your self-hosted SiYuan knowledge base to retrieve specific information, extract block-level data, and generate reports without using the desktop application.

Do I need curl and jq to interact with the SiYuan Note API?

Yes, curl and jq are required dependencies for interacting with the SiYuan API, as curl handles executing authenticated POST requests and jq parses the returned JSON data from the kernel.

What is the best way to sync external tasks into a self-hosted SiYuan workspace?

The best way to sync external tasks into SiYuan is using API automation to append content like daily meeting notes directly into your workspace blocks, bypassing manual desktop interaction.

How does full-text search work for blocks in a SiYuan knowledge base?

Full-text search in SiYuan works by sending API requests to the kernel to query blocks containing specific keywords, returning ranked results based on the search term provided.

Can I use this API approach for large-scale document manipulation in SiYuan?

Yes, this approach supports large-scale document manipulation in SiYuan by executing batch CRUD operations and SQL data retrieval against self-hosted knowledge bases programmatically.