siyuan

Interact with the SiYuan Notebase API using curl commands.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill simplifies the interaction with your SiYuan Notebase, enabling you to search, read, create, and manage blocks and documents through curl commands.

Core Features & Use Cases

  • API Integration: Utilize SiYuan Note API for searching, reading, creating, and managing blocks and documents.
  • Curl Commands: Access and manipulate your Notebase via curl, no extra tools required.
  • Use Case: Quickly retrieve information from your knowledge base by querying documents and blocks.

Quick Start

Use the siyuan skill to search for all blocks containing 'project management'.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I interact with the SiYuan Notebase API using curl?

You can interact with the SiYuan Notebase API by executing curl commands to search, read, create, and manage blocks and documents within your self-hosted knowledge base.

What do I need to manage documents in a self-hosted SiYuan knowledge base?

To manage documents in a self-hosted SiYuan knowledge base, you need curl to execute API requests and jq to parse the returned JSON responses.

Can I search for specific blocks in SiYuan notes via the command line?

Yes, you can search for specific blocks in SiYuan notes via the command line by utilizing the SiYuan Note API through curl commands to query your documents.

Does the SiYuan API require extra tools to parse JSON responses?

Yes, the SiYuan API requires the jq tool to parse JSON responses returned from curl commands, ensuring you can effectively read and manipulate the data from your knowledge base.

What is the best way to create and manage blocks in SiYuan without extra tools?

The best way to create and manage blocks in SiYuan without extra tools is using curl commands to directly access the Notebase API for block and document manipulation.

Are there limitations when using curl for notes management in SiYuan?

Using curl for notes management in SiYuan limits you to command-line interactions, requiring manual construction of API requests and jq for JSON parsing, lacking a graphical interface.