cli-anything-obsidian

cli-anything-obsidian

Obsidian Local REST API を介したナレッジ管理とノート作成。GUI を使わずにノートを管理し、Vault を検索し、コマンドを実行する必要がある AI エージェントやパワーユーザー向けに設計されています。

インストール

この CLI は cli-anything-obsidian パッケージの一部としてインストールされます:

pip install cli-anything-obsidian

前提条件:

• Python 3.10+
• Obsidian がインストールされ、Local REST API プラグインを有効にして実行されている必要があります

使用方法

基本コマンド

# Show help
cli-anything-obsidian --help

# Start interactive REPL mode
cli-anything-obsidian

# List vault files
cli-anything-obsidian vault list

# Run with JSON output (for agent consumption)
cli-anything-obsidian --json vault list

REPL モード

サブコマンドを指定せずに起動すると、CLI は対話型の REPL セッションに入ります:

cli-anything-obsidian
# Enter commands interactively with tab-completion and history

コマンドグループ

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	現在のセッション状態を表示します

例

ノートの一覧表示と読み取り

# List all vault files
cli-anything-obsidian vault list

# List files in a subdirectory
cli-anything-obsidian vault list "Daily Notes"

# Read a note
cli-anything-obsidian vault read "Projects/my-project.md"

ノートの作成と更新

# Create a new note
cli-anything-obsidian vault create "Projects/new-project.md" --content "# New Project"

# Update (overwrite) a note
cli-anything-obsidian vault update "Projects/new-project.md" --content "# Updated Content"

# Append to a note
cli-anything-obsidian vault append "Projects/new-project.md" --content "\n## New Section"

検索

# Plain text search (GET /search/simple/)
cli-anything-obsidian search simple "meeting notes"

# Dataview DQL query — default --type dql, sent as
# application/vnd.olrapi.dataview.dql+txt
cli-anything-obsidian search query 'TABLE file.link FROM "Projects"'

# JsonLogic query — application/vnd.olrapi.jsonlogic+json
cli-anything-obsidian search query --type jsonlogic \
  '{"==":[{"var":"frontmatter.status"},"active"]}'

コマンド

# List available commands
cli-anything-obsidian command list

# Execute a command by ID
cli-anything-obsidian command execute "editor:toggle-bold"

対話型 REPL セッション

探索的に使用するための対話型セッションを開始します。

cli-anything-obsidian
# Enter commands interactively
# Use 'help' to see available commands

API キーの設定

# Via flag
cli-anything-obsidian --api-key YOUR_KEY vault list

# Via environment variable (recommended for agents)
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

# Human output
cli-anything-obsidian vault list

# JSON output for agents
cli-anything-obsidian --json vault list

AI エージェント向け

この CLI をプログラムから使用する場合:

1. 常に --json フラグを使用する — 解析可能な出力のため
2. リターンコードを確認する — 0 は成功、非ゼロはエラー
3. 失敗時は stderr を解析する — エラーメッセージを取得するため
4. OBSIDIAN_API_KEY 環境変数を設定する — 毎回の呼び出しで --api-key を渡すのを避けるため
5. 他のコマンドの前に server status で Obsidian が実行中であることを確認する

詳細情報

• 完全なドキュメント: パッケージ内の README.md を参照してください
• テストカバレッジ: パッケージ内の TEST.md を参照してください
• 方法論: cli-anything-plugin 内の HARNESS.md を参照してください

バージョン

1.1.0