cli-anything-obsidian は何をしますか？
ObsidianのローカルREST APIを介したナレッジ管理とノートテイキング。AIエージェントやパワーユーザー向けに設計されており、GUIなしでノートを管理、vaultを検索、コマンドを実行できます。
インストール
このCLIはcli-anything-obsidianパッケージの一部としてインストールされます：
pip install cli-anything-obsidian
前提条件：
- Python 3.10+
- Obsidianがインストールされており、Local REST APIプラグインが有効になっていること
使用方法
基本コマンド
# ヘルプを表示
cli-anything-obsidian --help
# インタラクティブREPLモードを開始
cli-anything-obsidian
# vaultファイルを一覧表示
cli-anything-obsidian vault list
# JSON出力で実行（エージェント向け）
cli-anything-obsidian --json vault list
REPLモード
サブコマンドなしで呼び出すと、インタラクティブなREPLセッションに入ります：
cli-anything-obsidian
# タブ補完と履歴機能を使って対話的にコマンドを入力
コマンドグループ
Vault
Vaultファイル管理コマンド。
| コマンド | 説明 |
|---|---|
list | vaultまたはサブディレクトリ内のファイルを一覧表示 |
read | ノートの内容を読み込む |
create | 新しいノートを作成 |
update | 既存のノートを上書き |
delete | vaultからノートを削除 |
append | 既存のノートに内容を追記 |
Search
Vault検索コマンド。
| コマンド | 説明 |
|---|---|
query | Obsidianクエリ構文で検索 |
simple | vault全体をプレーンテキスト検索 |
Note
アクティブノートコマンド。
| コマンド | 説明 |
|---|---|
active | Obsidianで現在アクティブなノートを取得 |
open | Obsidianエディタでノートを開く |
Command
Obsidianコマンドパレットコマンド。
| コマンド | 説明 |
|---|---|
list | 利用可能なObsidianコマンドをすべて一覧表示 |
execute | IDを指定してコマンドを実行 |
Server
サーバーステータスと情報コマンド。
| コマンド | 説明 |
|---|---|
status | Obsidian Local REST APIが動作しているか確認 |
Session
セッション状態コマンド。
| コマンド | 説明 |
|---|---|
status | 現在のセッション状態を表示 |
使用例
ノートの一覧表示と読み込み
# すべてのvaultファイルを一覧表示
cli-anything-obsidian vault list
# サブディレクトリ内のファイルを一覧表示
cli-anything-obsidian vault list "Daily Notes"
# ノートを読み込み
cli-anything-obsidian vault read "Projects/my-project.md"
ノートの作成と更新
# 新しいノートを作成
cli-anything-obsidian vault create "Projects/new-project.md" --content "# 新規プロジェクト"
# ノートを更新（上書き）
cli-anything-obsidian vault update "Projects/new-project.md" --content "# 更新された内容"
# ノートに追記
cli-anything-obsidian vault append "Projects/new-project.md" --content "\n## 新しいセクション"
検索
# プレーンテキスト検索（GET /search/simple/）
cli-anything-obsidian search simple "会議ノート"
# Dataview DQLクエリ — デフォルト --type dql、
# application/vnd.olrapi.dataview.dql+txt として送信
cli-anything-obsidian search query 'TABLE file.link FROM "Projects"'
# JsonLogicクエリ — application/vnd.olrapi.jsonlogic+json
cli-anything-obsidian search query --type jsonlogic \
'{"==":[{"var":"frontmatter.status"},"active"]}'
コマンド
# 利用可能なコマンドを一覧表示
cli-anything-obsidian command list
# コマンドをIDで実行
cli-anything-obsidian command execute "editor:toggle-bold"
インタラクティブREPLセッション
探索的な使用のために対話セッションを開始します。
cli-anything-obsidian
# コマンドを対話的に入力
# 'help' で利用可能なコマンドを表示
APIキー設定
# フラグを使用
cli-anything-obsidian --api-key YOUR_KEY vault list
# 環境変数を使用（エージェント推奨）
export OBSIDIAN_API_KEY=YOUR_KEY
cli-anything-obsidian vault list
状態管理
CLIは軽量なセッション状態を保持します：
- APIキー：
--api-keyフラグまたはOBSIDIAN_API_KEY環境変数で設定可能 - ホストURL：デフォルトは
https://localhost:27124、--hostフラグで設定可能
出力形式
すべてのコマンドは2つの出力モードをサポートしています：
- 人間可読（デフォルト）：表、色付き、整形テキスト
- 機械可読（
--jsonフラグ）：エージェント向けの構造化JSON
# 人間向け出力
cli-anything-obsidian vault list
# エージェント向けJSON出力
cli-anything-obsidian --json vault list
AIエージェント向け
このCLIをプログラム的に使用する場合：
- 常に
--jsonフラグを使用して解析可能な出力を得る - リターンコードを確認 - 0は成功、0以外はエラー
- エラー時にstderrを解析してエラーメッセージを取得
OBSIDIAN_API_KEY環境変数を設定して、毎回--api-keyを渡すのを避ける- 他のコマンドの前に
server statusでObsidianが実行中であることを確認
詳細情報
- 完全なドキュメント：パッケージ内のREADME.mdを参照
- テストカバレッジ：パッケージ内のTEST.mdを参照
- 方法論：cli-anything-plugin内のHARNESS.mdを参照
バージョン
1.1.0