cli-anything-siyuan は何をしますか？
SiYuan（思源笔记） 用CLIハーネス。ローカライズされたナレッジ管理・ノート作成アプリケーションです。
この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 '%キーワード%'" を使用
- ドキュメントIDは
20210817205410-2kvfpfn のようなタイムスタンプベースです
- APIトークンはSiYuanの設定 → バージョン情報で確認できます
- 接続のデフォルト:
http://127.0.0.1:6806
使用例
cli-anything-siyuan --json notebook list
cli-anything-siyuan doc create nb1 /projects/new --md "## タイトル\n\n内容"
@'
## タイトル
`バッククオート`と(括弧)と"引用符"を含む内容
'@ | cli-anything-siyuan doc create nb1 /projects/new --md -
cli-anything-siyuan sql "SELECT id, content FROM blocks WHERE content LIKE '%ミーティング%' LIMIT 5"
cli-anything-siyuan export md doc123
cli-anything-siyuan
エラー処理
- 接続エラー: SiYuanが実行中であり、APIトークンが正しいことを確認してください
- APIエラー:
{"code": N, "msg": "..."} として返されます — メッセージフィールドを確認してください
- 認証エラー:
~/.siyuan-cli.json のトークンまたは SIYUAN_TOKEN 環境変数を確認してください