cli-anything-siyuan

cli-anything-siyuan

SiYuan（思源笔记）向けの CLI ハーネスです。 SiYuan はローカルファーストのナレッジ管理およびノート作成アプリケーションです。

この CLI は、実行中の SiYuan カーネルに HTTP API （http://127.0.0.1:6806）経由で接続し、ノートブック、ドキュメント、ブロック、検索、エクスポートへの構造化されたアクセスを提供します。

前提条件

• SiYuan が実行されている必要があります（設定 → について に API トークンが表示されます）
• Python 3.10+
• インストール: pip install cli-anything-siyuan、または agent-harness/ から pip install -e .

コマンドグループ

notebook — ノートブック管理

サブコマンド	説明
list	すべてのノートブックを一覧表示
create <name>	新しいノートブックを作成
rename <id> <name>	ノートブックの名前を変更
remove <id>	ノートブックを削除
open <id>	ノートブックを開く

doc — ドキュメント管理

サブコマンド	説明
create <notebook> <path> [--md "content"]	ドキュメントを作成
list <notebook> [path]	ドキュメントを一覧表示
tree <notebook> [--path / --depth]	ドキュメントツリーを表示
get <id>	ID からドキュメントパスを取得
rename <id> <title>	ドキュメントの名前を変更
remove <id>	ドキュメントを削除

block — ブロック操作

サブコマンド	説明
insert <data> [--previous / --parent]	ブロックを挿入
update <id> <data>	ブロックを更新
delete <id>	ブロックを削除
get <id>	ブロックの kramdown ソースを取得
children <id>	子ブロックを取得

その他のコマンド

コマンド	説明
sql <stmt>	ブロックデータベースに対して SQL を実行
search <query>	ブロック全体を対象に全文検索
export md <doc-id>	ドキュメントを Markdown としてエクスポート
tag list	すべてのタグを一覧表示
version	SiYuan カーネルのバージョンを表示
status	接続およびセッションのステータスを表示
repl	対話型 REPL を開始

エージェント向けガイダンス

• 機械可読な出力には常に --json を使用してください
• 強力な検索: SQL レベルのアクセスには sql "SELECT * FROM blocks WHERE content LIKE '%keyword%'" を使用してください
• ドキュメント ID は 20210817205410-2kvfpfn のような形式です（タイムスタンプベース）
• API トークンは SiYuan の 設定 → について で確認できます
• 接続のデフォルト: 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

エラー処理

• 接続エラー: SiYuan が実行されていること、および API トークンが正しいことを確認してください
• API エラー: {"code": N, "msg": "..."} として返されます — message フィールドを確認してください
• 認証エラー: ~/.siyuan-cli.json または SIYUAN_TOKEN 環境変数のトークンを確認してください