siyuan

Search, read, create, and manage blocks and documents via the SiYuan Note API.

539|39|Updated May 1, 2026
One-click install
npx skills add https://github.com/Tommy-yw/RunbookHermes --skill siyuan-tommy-yw
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/Tommy-yw/RunbookHermes/tree/main/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/Tommy-yw/RunbookHermes --skill siyuan-tommy-yw

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires curl, jq, and includes scripts (resource) components.

What problem does it solve?

This Skill simplifies interacting with your SiYuan knowledge base, allowing you to search, read, create, and manage blocks and documents using curl.

Core Features & Use Cases

  • API Integration: Leverage the SiYuan Note API for seamless knowledge base operations.
  • Search & Read: Perform full-text and SQL searches, read blocks and documents.
  • Create & Manage: Add, update, and delete blocks and documents, and organize notebooks.
  • Use Case: Quickly find and manage notes or documents in your SiYuan knowledge base without leaving your command line.

Quick Start

Use the siyuan skill to search for notes containing 'project planning'.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I manage SiYuan knowledge base blocks from the command line?

You can manage SiYuan knowledge base blocks from the command line by using API integration scripts that leverage curl to search, read, create, and delete notes without leaving your terminal.

What do I need to interact with my self-hosted SiYuan API?

To interact with your self-hosted SiYuan API, you need curl and jq installed, along with a valid SiYuan API token to authenticate your knowledge base operations.

Can I perform SQL searches on my SiYuan notes using curl?

Yes, you can perform SQL searches on your SiYuan notes using curl, allowing you to execute full-text and structured queries to find and read specific blocks within your knowledge base.

What is the best way to automate document creation in a SiYuan knowledge base?

The best way to automate document creation in a SiYuan knowledge base is using API scripts that send curl requests to add, update, and organize documents and notebooks automatically.

Does this approach require an API token for every block management operation?

Yes, an API token is required for every block management operation to authenticate your curl requests when accessing your self-hosted SiYuan knowledge base.