Achuan-2/siyuan-plugin-copilot

asset

Asset management. Actions: upload(id, files=comma-separated absolute paths), unused(), clean(path?), stat(path).

Source text: Chinese

attr

Block custom-attribute operations. Actions: get(id), set(id, attrs object), batch-get(ids comma-separated).

Source text: Chinese

block

Block operations. Actions: get(id), get_kramdown(id), get_children(id), tree_stat(id, by document), dom(id), insert(data, dataType, parentID?, nextID?, previousID?), append(data, dataType, parentID) / prepend(...) add a NEW child — use after block.update when…

Source text: Chinese

bookmark

Bookmark management. Actions: list(), labels(), remove(label), rename(old, new).

Source text: Chinese

dailynote

Daily note operations. Actions: create(notebook) — create/open today's note, append(notebook, data, dataType?) / prepend(...) add a block.

Source text: Chinese

database

Attribute view (database) operations. Actions: search(keyword), get(id), render(id, viewID?, query?, page=1, pageSize=50), keys(id), key_add(id, name, type, icon?, prev?), key_remove(id, keyID, removeRelationDest?), item_add(id, blockID?, content?, viewID?,…

Source text: Chinese

document

Document operations. Actions: get(id), create(notebook, path=hPath, title, markdown?), list(notebook, path=hPath default /), delete(id), rename(id, title), move(id, notebook, path=target hPath), duplicate(id), search_docs(keyword), info(id).

Source text: Chinese

export

Export operations. Actions: md(id), html(id), preview(id), docx(id, output path), sy(id) → .sy.zip, md-zip(id), data() → full workspace backup.

Source text: Chinese

file

Workspace file operations (paths relative to workspace; debugging/log reading only — never use for workspace data). Actions: list(path, limit=200, 0/-1=unlimited), read(path, offset, limit; default 200 lines, limit=-1 for full), write(path, data),…

Source text: Chinese

frontend

Frontend/UI actions in the SiYuan editor (run in the browser; may change what the user sees). Actions: open_setting(query?), focus_block(id), open_document(id), open_search(query?). Plugins may register more — see <plugin_actions> and invoke by full name…

history

Document history operations. Actions: list(query?, notebook?, op?, type?, page?), search(query, notebook?, op?, type?, page?), get(path), rollback(path), clear().

Source text: Chinese

http-request

Send an HTTP request to a REST API and return the raw text response (JSON is kept as-is). action (HTTP method): get (default)/post/put/delete/patch. url (http/https), headers (object), body (string). Use this instead of web_fetch when you need POST, custom…

import

Import operations (absolute local paths). Actions: md(notebook, path, targetPath?), sy(notebook, path, targetPath?) — .sy.zip, data(path) — full backup zip.

Source text: Chinese

inbox

Inbox management (cloud-clipped web pages, messages, and audio/video/file attachments; requires subscription). Actions: list(page=1), get(id), convert(ids, notebook, path=/, remove_after=true) — converts one or more shorthands into local documents under the…

Source text: Mixed languages

notebook

Notebook management. Actions: list(), open(id), close(id), create(name), rename(id, name), remove(id), set_icon(id, icon), random_icon(id?).

Source text: Chinese

outline

Document outline (heading tree). Action: get(id).

Source text: Undetermined

question

Ask the user questions to clarify needs/preferences (do NOT use for plain-text option lists). questions[]: each {header (short label), question, options[] {label, description}, multiple?, custom?}.

ref

Reference/backlink operations. Actions: backlinks(id, keyword?, sort?), mentions(id, keyword?, sort?), refresh(id).

Source text: Chinese

repo

Repository (data snapshot) operations. Actions: list(tag?, page=1), create(memo?), tag(id, name), untag(name), checkout(id), diff(left, right), search(keyword, page?), purge(), file_get(id), file_rollback(id), file_open(id), file_export(id).

Source text: Chinese

search

Search. Actions: fulltext(query, page=1, pageSize=20, notebook?, path?, type?, subtype?, method?, orderBy?, groupBy?), semantic(query, page=1, pageSize=20, notebook?, path?, type?, subtype?) — semantic needs AI embedding configured; asset(query, page=1,…

skill

Skill operations: load(name), save(name, content), install(url), remove(name), rename(name, new_name), list().

Source text: Chinese

sql

Read-only SQL on SiYuan's database. Action: query(stmt) — SELECT only.

sync

Data sync operations. Actions: perform() (full upload+download), upload(), download(), status().

Source text: Chinese

system

System info. Actions: version(), current_time(), workspace().

Source text: Chinese

tag

Tag management. Actions: list(keyword?), rename(old, new), remove(label).

Source text: Chinese

template

Template management. Actions: search(keyword?), get(path), remove(path), render(path, id), save_as(id, name, overwrite?), create(name, content, overwrite?).

Source text: Chinese

todo-write

Maintain a session task list (each call replaces the list). todos[]: each {content, status: pending|in_progress|completed|cancelled}.

unzip

Extract a zip archive within the workspace. Provide the workspace-relative path to the zip file and the destination directory (also workspace-relative). The destination will be created if it does not exist.

web-fetch

Fetch a web page and convert to Markdown or text. url (http/https), format: markdown (default) or text.

web-search

Web search via Exa, returns text results. Action: query(keywords).

Source text: Undetermined

workspace

Workspace management. Actions: list(), info() (path, version, valid).

Source text: Chinese