obsidian-skill について
実行中の Obsidian アプリ、インデックス、設定、コマンド登録に依存する作業で Obsidian CLI を使うためのスキルです。CLI の特定方法や対象 Vault の指定を案内し、セッション維持と慎重な操作を促します。
主な機能
- 01CLI 実行ファイルの特定と検証
- 02Vault とパスの正確な指定
- 03読み取り、書き込み、検索、メタデータ確認
- 04導入済みバージョンのヘルプとガイドの参照
- 05実行中セッションと慎重な操作の保護
活用シーン
- 01Vault 内のノート検索や読み取り
- 02指定ノートへの内容の追記
- 03ノートのプロパティやバックリンクの確認
- 04導入済みバージョンで使えるコマンドの確認
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ gmickel/ obsidian-skill --skill obsidian-skillインストール後、Claude Code で/obsidian-skillを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
metadata.jsonLICENSEREADME.md.github/FUNDING.ymlreferences/daily-tasks-templates.mdsearch-metadata.mdnote-operations.mdvault-management.md詳細
Obsidian CLI
Obsidian の実行中のアプリケーション、インデックス、設定、コマンドレジストリ、開発者ランタイムに依存する動作には、CLI を使用してください。通常のファイル操作には、通常のファイルシステムツールを使用してください。
CLI を解決して確認する
実行ファイル名を一つに決めつけないでください。Obsidian の登録方法やパッケージングはプラットフォームやリリースによって異なり、無関係なサードパーティ製バイナリが同じ名前を使っている場合もあります。version の確認に成功した候補だけを選んでください。
macOS/Linux の場合:
resolve_obsidian_cli() {
local candidate
for candidate in \
"${COPILOT_OBSIDIAN_CLI:-}" \
/Applications/Obsidian.app/Contents/MacOS/obsidian-cli \
"$(command -v obsidian 2>/dev/null || true)" \
"$(command -v obsidian-cli 2>/dev/null || true)"
do
[[ -n "$candidate" && -x "$candidate" ]] || continue
if "$candidate" version >/dev/null 2>&1; then
printf '%s\n' "$candidate"
return 0
fi
done
return 1
}
OBSIDIAN_CLI=$(resolve_obsidian_cli) || {
echo "Obsidian CLI unavailable" >&2
exit 1
}
"$OBSIDIAN_CLI" version
PowerShell の場合:
$candidates = @(
$env:COPILOT_OBSIDIAN_CLI,
(Get-Command obsidian -ErrorAction SilentlyContinue).Source,
(Get-Command obsidian-cli -ErrorAction SilentlyContinue).Source
) | Where-Object { $_ }
$OBSIDIAN_CLI = $candidates | Where-Object {
try { & $_ version *> $null; $LASTEXITCODE -eq 0 } catch { $false }
} | Select-Object -First 1
if (-not $OBSIDIAN_CLI) { throw "Obsidian CLI unavailable" }
& $OBSIDIAN_CLI version
確認に失敗した場合は、互換性のある Obsidian リリースを開き、設定 > 一般 > コマンドラインインターフェースを有効にして登録を完了し、ターミナルを再起動するようユーザーに依頼してください。ユーザーの明示的な意図がない限り、Obsidian のインストール、PATH の変更、CLI の登録は行わないでください。
すべての参照例で、obsidian の代わりに解決済みの実行ファイルを使用してください。
"$OBSIDIAN_CLI" vaults
"$OBSIDIAN_CLI" help search
ボルトを正確に指定する
対象がわかっている場合は、vault="<name-or-id>" を使用してください。このスキルに個人用のボルト名やマシンのパスを埋め込まないでください。
"$OBSIDIAN_CLI" vault="<vault-name>" search query="project deadline" format=json
"$OBSIDIAN_CLI" vault="<vault-name>" backlinks path="Projects/Plan.md" format=json
ボルト内の正確な相対パスを指定するには path= を使用してください。Obsidian のウィキリンク形式の名前解決を使う場合に限り、file= を使用してください。スペースやシェルの特殊文字を含む値は引用符で囲んでください。インストール済みバージョンに記載されていない構文に依存する前に、現在のヘルプを確認してください。
"$OBSIDIAN_CLI" help <command>
基本操作
# Read and write
"$OBSIDIAN_CLI" vault="<vault-name>" read path="Projects/Roadmap.md"
"$OBSIDIAN_CLI" vault="<vault-name>" append path="Journal.md" content="- New entry"
# Search and metadata
"$OBSIDIAN_CLI" vault="<vault-name>" search query="API" limit=10 format=json
"$OBSIDIAN_CLI" vault="<vault-name>" properties path="Projects/Roadmap.md"
# Configured daily note and indexed tasks
"$OBSIDIAN_CLI" vault="<vault-name>" daily:append content="- 2pm: Call" silent
"$OBSIDIAN_CLI" vault="<vault-name>" tasks all todo
# Live workspace
"$OBSIDIAN_CLI" vault="<vault-name>" tabs ids
"$OBSIDIAN_CLI" vault="<vault-name>" workspace ids
ホストセッションを維持する
エージェントセッションから Obsidian アプリやウィンドウを再読み込みまたは再起動しないでください。現在のエージェントセッションをホストしているプラグインを再読み込み、無効化、アンインストールしないでください。同等のコマンド、JavaScript、開発者ツールによる操作も避けてください。これらの操作はセッションを終了させ、進行中の作業を失わせる可能性があります。
完全削除、ローカル履歴または Sync からの復元、公開または非公開化、プラグインやテーマのインストールまたは削除、制限モードの変更、JavaScript や開発者向けの変更を伴う呼び出しを行う前に、ユーザーの明示的な意図を確認してください。元に戻せる操作を優先してください。コマンドの参照情報は機能を説明するものであり、変更を許可するものではありません。
リファレンスガイド
タスクに関連するガイドだけを読んでください。各ガイドの例にある obsidian は、解決済みの $OBSIDIAN_CLI 実行ファイルとして扱い、対象がわかっている場合は vault="<name-or-id>" を追加してください。
| タスク | リファレンス |
|---|---|
| ノートの操作、アウトライン、単語数、ユニークノート | references/note-operations.md |
| 検索、タグ、プロパティ、バックリンク、孤立ノート、未解決リンク | references/search-metadata.md |
| デイリーノート、タスク、テンプレート | references/daily-tasks-templates.md |
| ボルト、ワークスペース、ブックマーク、プラグイン、テーマ、Sync、Publish、Bases、開発者ツール | references/vault-management.md |