| name | siyuan-sisyphus-search-query |
| description | CLI-only playbook for finding and querying SiYuan content with siyuan-sisyphus. Use for fulltext, read-only SQL, backlinks, references, assets, dynamic query blocks, and safe find-replace. |
Search and Query SiYuan with the CLI
Search to identify candidates, read the target by ID or path, and only then edit. Use explicit pagination for repeatable results.
siyuan-sisyphus search fulltext --query 'keyword' --page '1' --page-size '20' --json
siyuan-sisyphus search fulltext --query 'keyword' --parent-id '<doc-id>' --type-shortcodes-json '["h","p"]' --json
siyuan-sisyphus search query-sql --stmt 'SELECT id, hpath, content FROM blocks WHERE type = '"'"'p'"'"' ORDER BY updated DESC LIMIT 10' --json
siyuan-sisyphus search get-backlinks --id '<block-or-doc-id>' --mode 'both' --json
siyuan-sisyphus search search-refs --id '<block-id>' --before-len '512' --json
siyuan-sisyphus search search-assets --query 'diagram' --exts-json '["png","jpg","webp"]' --json
SQL must be read-only and must include LIMIT. Useful tables include blocks, blocks_fts, attributes, refs, spans, and assets.
Find and replace
This action mutates content. First search, read each target, show the exact old/new text and IDs, and obtain explicit approval.
siyuan-sisyphus search find-replace --k 'old text' --r 'new text' --ids-json '["<doc-id>"]' --json
Read the changed blocks again. Recent writes can take time to enter the search index; verify a fresh mutation by ID or path rather than assuming an empty search means failure. Use siyuan-sisyphus help search query-sql for live SQL action constraints.