siyuan

Access the SiYuan Note API via command line to search, read, create, and update blocks and documents.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This skill solves the problem of manually searching, reading, creating, and managing blocks and documents in a self-hosted SiYuan knowledge base by providing an API that can be accessed via curl.

Core Features & Use Cases

  • API Access: Access SiYuan Note's API for operations like searching, reading, creating, and updating blocks and documents.
  • Command-line Interface: Use curl commands to perform actions without the need for a graphical user interface.
  • Use Case: Quickly search for content within your SiYuan database using full-text search or SQL queries without leaving your terminal.

Quick Start

Run 'clawbot siyuan search "keyword"' to perform a full-text search for a keyword in your SiYuan knowledge base.

Frequently Asked Questions about siyuan

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

FAQPage Schema
How do I manage SiYuan Note documents from the command line?

You can manage SiYuan Note documents from the command line by using this skill to send API requests via curl, enabling you to search, read, create, and update blocks and documents directly.

Can I search my self-hosted knowledge base using terminal commands?

Yes, you can search your self-hosted knowledge base using terminal commands by running a full-text search or SQL query against the SiYuan API, retrieving matching blocks without a graphical interface.

Do I need curl and jq to interact with the SiYuan API?

Yes, you need curl and jq to interact with the SiYuan API because this skill relies on curl to send HTTP requests and jq to process the JSON responses returned from your knowledge base.

What is the best way to create and update blocks in SiYuan without a GUI?

The best way to create and update blocks in SiYuan without a GUI is through this command-line interface, which formats API requests to directly manipulate block content within your self-hosted document database.

Does this API integration support full-text search for SiYuan block management?

This API integration supports full-text search for SiYuan block management by passing your specified keywords through the command-line interface to query and retrieve matching block data from the knowledge base.