Manage SiYuan notebooks, documents, and blocks, the individual pieces of note content, from the terminal. Search your knowledge base, create or update notes, inspect document structure, and export documents as Markdown through its local API.
SiYuan (思源笔记) CLI — manage notebooks, documents, blocks, and search your knowledge base from the terminal.
Review the instructions the agent will receive before you install.
CLI harness for SiYuan (思源笔记), a local-first knowledge management and note-taking application.
This CLI connects to a running SiYuan kernel via its HTTP API
(http://127.0.0.1:6806) and provides structured access to notebooks,
documents, blocks, search, and export.
pip install cli-anything-siyuan or pip install -e . from agent-harness/| Subcommand | Description |
|---|---|
list | List all notebooks |
create <name> | Create a new notebook |
rename <id> <name> | Rename a notebook |
remove <id> | Delete a notebook |
open <id> | Open a notebook |
| Subcommand | Description |
|---|---|
create <notebook> <path> [--md "content"] | Create a document |
list <notebook> [path] | List documents |
tree <notebook> [--path / --depth] | Show doc tree |
get <id> | Get document path by ID |
rename <id> <title> | Rename a document |
remove <id> | Delete a document |
| Subcommand | Description |
|---|---|
insert <data> [--previous / --parent] | Insert a block |
update <id> <data> | Update a block |
delete <id> | Delete a block |
get <id> | Get block kramdown source |
children <id> | Get child blocks |
| Command | Description |
|---|---|
sql <stmt> | Execute SQL on the block database |
search <query> | Full-text search across blocks |
export md <doc-id> | Export document as Markdown |
tag list | List all tags |
version | Show SiYuan kernel version |
status | Show connection and session status |
repl | Start interactive REPL |
--json for machine-readable outputsql "SELECT * FROM blocks WHERE content LIKE '%keyword%'" for SQL-level access20210817205410-2kvfpfn (timestamp-based)http://127.0.0.1:6806# List notebooks (JSON)
cli-anything-siyuan --json notebook list
# Create a document with Markdown (--md flag, watch shell escaping)
cli-anything-siyuan doc create nb1 /projects/new --md "## Title\n\nContent"
# Create a document — pipe Markdown via stdin (avoids shell escaping)
# PowerShell here-string (literal, no escaping needed):
@'
## Title
Content with `backticks` and (parentheses) and "quotes"
'@ | cli-anything-siyuan doc create nb1 /projects/new --md -
# Bash heredoc:
# cat <<'EOF' | cli-anything-siyuan doc create nb1 /projects/new --md -
# ## Title
# Content with `backticks` and (parentheses)
# EOF
# SQL search
cli-anything-siyuan sql "SELECT id, content FROM blocks WHERE content LIKE '%meeting%' LIMIT 5"
# Export
cli-anything-siyuan export md doc123
# Enter REPL
cli-anything-siyuan
{"code": N, "msg": "..."} — check the message field~/.siyuan-cli.json or SIYUAN_TOKEN env varNo reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Use Reasonix to build or improve a Python command-line interface for existing software. The workflow covers source analysis, interactive commands, JSON output, tests, documentation, and installation checks using the software’s own backend where possible.
Build and improve Python command interfaces for GUI applications with OpenClaw. The skill guides source analysis, command design, testing, and packaging, including interactive sessions and structured JSON output for agents.
Use Codex to build Python command-line tools for applications with graphical interfaces. Analyze source code, add commands, test against the actual software, validate packaging and documentation, and discover tools already generated or installed.
Inspect and edit 3MF files for 3D printing. Detect cylindrical holes, change their diameters, repair mesh issues, and compare files while preserving BambuStudio and PrusaSlicer metadata when repacking the edited file.
Manage AdGuard Home network filtering from the command line. Update blocklists, register devices, configure DNS rules that map names to addresses, and inspect query logs and statistics through the AdGuard Home REST API.
Generate slides, documents, websites, and diagrams from natural language prompts through AnyGen OpenAPI. Manage reference uploads, check generation progress, and download finished files using commands with structured output for AI agents.