siyuan

Search, read, create, and update SiYuan blocks and documents via curl.

Updated May 2, 2026
One-click install
npx skills add https://github.com/AlvaroBiano/hermes-agent --skill siyuan-alvarobiano
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan
Source: https://github.com/AlvaroBiano/hermes-agent/tree/main/optional-skills/productivity/siyuan
Command: npx skills add https://github.com/AlvaroBiano/hermes-agent --skill siyuan-alvarobiano

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Remote and local teams often face friction managing a self-hosted SiYuan knowledge base through manual, GUI-driven workflows. This skill provides a programmatic interface to search, read, create, update, and delete blocks and documents via the SiYuan kernel API using curl.

Core Features & Use Cases

  • Programmatic access to SiYuan: search full-text blocks, read content, and modify documents from scripts or CI pipelines.
  • Automated knowledge workflows: create notes, organize blocks, and batch-update metadata across notebooks.
  • Use Case: When onboarding new project notes, automatically generate a notebook, seed it with templates, and populate initial documents via API calls.

Quick Start

Authenticate with your SiYuan API token and run a curl command to fetch a block by its ID.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I manage SiYuan notes programmatically via API?

You can manage SiYuan notes programmatically by sending curl requests to the SiYuan kernel API to search, read, create, and update blocks and documents, requiring your SiYuan API token and URL.

What do I need to automate knowledge base workflows in SiYuan?

To automate knowledge base workflows in SiYuan, you need a self-hosted SiYuan instance, your API token, the SiYuan URL, and curl installed to execute API operations for batch-updating metadata or seeding notebooks.

Can I use curl to search and read blocks in a self-hosted SiYuan knowledge base?

Yes, you can use curl to search and read blocks in a self-hosted SiYuan knowledge base by calling the SiYuan API, allowing scripts or CI pipelines to retrieve document content and perform full-text block searches.

Does the SiYuan API support creating notebooks and populating initial documents?

Yes, the SiYuan API supports creating notebooks and populating initial documents. You can use curl commands to programmatically generate notebooks, seed them with templates, and organize blocks for onboarding workflows.

What is the best way to batch update notes across local or remote SiYuan instances?

The best way to batch update notes across local or remote SiYuan instances is using curl to interact with the SiYuan kernel API, enabling automated modification of documents and blocks without manual GUI-driven workflows.