siyuan

Interact with the SiYuan kernel API to search and modify knowledge base blocks.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires curl, jq.

What problem does it solve?

This skill solves the friction of interacting with a local SiYuan knowledge base by providing a direct interface to its kernel API, allowing for programmatic note management without manual UI navigation.

Core Features & Use Cases

  • Block Manipulation: Search, read, create, update, and delete blocks or documents using standard API calls.
  • Knowledge Retrieval: Execute SQL queries against the SiYuan database to find specific information across your entire knowledge base.
  • Use Case: You can automate the creation of daily meeting notes or extract specific project-related blocks into a summary report by querying the SiYuan API directly from your terminal or agent environment.

Quick Start

Use the siyuan skill to search for all blocks containing the keyword project and return the first 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 searching and retrieving blocks from my SiYuan knowledge base?

You can automate searching and retrieving blocks by sending structured JSON-RPC requests to the SiYuan kernel API. This allows programmatic interaction with your local knowledge base files for automated search and retrieval without manual UI navigation.

Can I use SQL queries to find specific information across my SiYuan notes?

Yes, you can execute SQL queries against the SiYuan database to find specific information across your entire knowledge base. This enables targeted knowledge retrieval by querying blocks and documents directly through the kernel API.

What do I need to set up before programmatically managing my SiYuan notes?

You need a valid SiYuan API token, network access to your local SiYuan instance, and the command-line tools curl and jq installed. These dependencies are required to send API requests and parse the JSON responses.

Does the SiYuan API support creating and updating documents automatically?

Yes, the SiYuan kernel API supports block manipulation including creating, updating, and deleting blocks or documents. You can automate tasks like generating daily meeting notes by sending API calls from your terminal environment.

Why use API calls instead of the SiYuan UI for knowledge base management?

Using API calls eliminates the friction of manual UI navigation by providing a direct interface to the SiYuan kernel. This enables automated workflows like extracting project-related blocks into summary reports directly from your terminal or agent environment.

What are the limitations of interacting with a local SiYuan knowledge base via API?

This approach requires a running local SiYuan instance and a valid API token for network access. It depends on curl and jq for sending requests and parsing JSON-RPC responses, limiting use to environments where these tools are available.