siyuan

Automate search, reading, creation, and management of SiYuan blocks and documents.

1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/zerwiz/wayofpi --skill siyuan-zerwiz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/zerwiz/wayofpi/tree/main/.hermes/hermes-agent/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/zerwiz/wayofpi --skill siyuan-zerwiz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the friction of manually searching, editing, and organizing content inside a self-hosted SiYuan knowledge base by exposing the core notebook and block operations through simple API workflows.

Core Features & Use Cases

  • Search and retrieval: Find blocks, documents, and notebook content with full-text search or SQL queries.
  • Content management: Create, update, append, rename, and delete documents or blocks with precise API calls.
  • Knowledge-base workflows: Support note maintenance, meeting capture, task tracking, and structured documentation in SiYuan.
  • Operational safety: Encourages token-based authentication, POST-only requests, and safe read-only SQL patterns for reliable automation.

Quick Start

Use the siyuan skill to search for a note topic, read the matching block, and update or create the document you need in your SiYuan workspace.

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 updating blocks in a SiYuan knowledge base?▼

You can automate searching and updating blocks in a SiYuan knowledge base by making token-authenticated POST requests with safe SELECT-only SQL queries to retrieve, create, or update document content.

Can I use SQL queries to retrieve notes from my self-hosted SiYuan workspace?▼

Yes, you can use safe SELECT-only SQL queries via POST requests to find blocks, documents, and notebook content within your self-hosted SiYuan workspace.

What do I need to manage SiYuan documents through API calls?▼

To manage SiYuan documents through API calls, you need a self-hosted SiYuan workspace, a valid authentication token, and validated SiYuan IDs to execute reliable POST requests.

Does the SiYuan API support creating and deleting documents programmatically?▼

Yes, the SiYuan API supports programmatically creating, updating, appending, renaming, and deleting documents or blocks through precise token-authenticated POST requests.

Are there limitations when running SQL queries to search a SiYuan knowledge base?▼

When searching a SiYuan knowledge base, you are limited to safe SELECT-only SQL patterns to ensure reliable API execution and prevent unsafe database modifications.

What is the best way to maintain structured notes in SiYuan without manual editing?▼

The best way to maintain structured notes without manual editing is automating block management and document workflows via token-authenticated POST requests to the SiYuan API.