Skip to content
Get packs

SiYuan Note CLI

Let an agent manage SiYuan notebooks, documents, blocks and search from the terminal

Source Download skill
Repository
HKUDS/CLI-Anything
Stars
58,084
Licence
Apache-2.0
Files
1 file

What it does

This skill teaches an AI agent to operate the SiYuan note-taking app through a command-line tool called cli-anything-siyuan. Once installed, the agent can list and create notebooks, create and edit documents and blocks, run full-text and SQL searches over your notes, export documents to Markdown, and check connection status. It talks to a SiYuan app already running on your own computer via its local HTTP API, using an API token from SiYuan's settings.

Great for

  • Users of SiYuan who want an agent to search, organise or write into their local knowledge base
  • Developers scripting bulk edits or exports of SiYuan notes
  • People comfortable with a terminal and Python tooling

Skip it if

  • Users who do not run SiYuan locally: the tool only reaches a SiYuan kernel at 127.0.0.1:6806 by default, so it will not work with other note apps
  • Bulk or destructive operations on important notes without a backup: commands such as notebook remove, doc remove and block delete permanently delete content, and arbitrary sql statements can modify the database

Try asking

  • “List my SiYuan notebooks and show the document tree for my 'Projects' notebook”
  • “Search my notes for everything mentioning 'meeting' and summarise the results”
  • “Create a new document called /projects/new in notebook nb1 with this Markdown content”
  • “Export document doc123 from SiYuan as Markdown”
Step-by-step guide: how to use SiYuan Note CLIInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 1 original files, the Apache-2.0 licence and an attribution note.

    skills.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip skills.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip skills.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Always ask the agent to use --json output so results are machine-readable and easier to check
  • Back up your SiYuan workspace before letting an agent delete notebooks, documents or blocks
  • Pipe Markdown via stdin (--md -) rather than inline strings to avoid shell escaping problems

What's inside

  • SKILL.md

Redistributed unmodified from HKUDS/CLI-Anything under the Apache-2.0 licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.