siyuan-skill

Name: siyuan-skill
Availability: InStock
Author: daze

Automate Siyuan Note notebook and document operations from the command line.

77|7|Updated Mar 7, 2026

Search Tags:#documents #cli #search #notes #vector #notebooks #siyuan

Ready to run

npx skills add https://github.com/dazexcl/siyuan-skill --skill siyuan-skill-dazexcl

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: siyuan-skill
Source: https://github.com/dazexcl/siyuan-skill/tree/main
Command: npx skills add https://github.com/dazexcl/siyuan-skill --skill siyuan-skill-dazexcl

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

Siyuan tasks often require repetitive, error-prone manual operations across notebooks, documents, blocks, and searches. This Skill provides a single CLI to automate these tasks, reducing time and errors.

Core Features & Use Cases

Notebook and document lifecycle: create, update, delete, move, and rename.
Block-level operations and content search: keyword, semantic, and hybrid search with vector indexing and NLP analysis.
Access control and safety: permission modes, delete protection, and integration with token-based authentication for remote Siyuan instances.
Use cases: automatically manage notebooks and docs, perform bulk updates, perform semantic searches, and build knowledge graphs from references.

Quick Start

Install the skill and run node {baseDir}/scripts/notebooks.js to verify installation.

Frequently Asked Questions about siyuan-skill

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

FAQPage Schema

How do I automate Siyuan note document management from the command line?▼

You can automate Siyuan note document management by using a CLI toolkit that executes notebook lifecycle operations, block-level control, and content searches directly through the Siyuan API. It requires Node.js >= 14 and authentication tokens for remote instances.

Can I perform semantic search across Siyuan notebooks?▼

Yes, semantic search across Siyuan notebooks is supported by integrating vector indexing and NLP analysis. You can perform keyword, semantic, and hybrid searches by optionally connecting Qdrant and Ollama services through configured environment variables.

What do I need to set up before using a Siyuan CLI for bulk document updates?▼

Before using a Siyuan CLI for bulk document updates, you need Node.js >= 14, Siyuan API access with base URL and token environment variables configured, and optionally Qdrant and Ollama for vector and NLP features.

Does the Siyuan API support block-level operations and delete protection?▼

Yes, the Siyuan API supports block-level operations and access control safety including permission modes and delete protection. This ensures safe automation of document and block operations during bulk updates.

What is the best way to build a knowledge graph from Siyuan note references?▼

The best way to build a knowledge graph from Siyuan note references is using CLI automation to extract document references and perform hybrid searches with vector indexing and NLP analysis across notebooks.

Are there limitations when managing Siyuan notes via API without vector services?▼

Without optional vector and NLP services like Qdrant and Ollama, Siyuan note management via API is limited to keyword search and standard block operations, lacking semantic and hybrid search capabilities for content analysis.