Obsidian

Obsidian CLI設定方法とPATH登録手順【Catalyst・Insiderビルド対応】

ⓘ本ページはプロモーションが含まれています

スポンサードリンク

Obsidian でターミナルからノートを操作したいときの実践ガイド

（公式機能ではなく、コミュニティプラグイン「Obsidian CLI」 を利用する前提です）

1. 前提 ― 公式に CLI 機能は存在しない

2024 年 10 月時点の Obsidian の公式ドキュメント（https://help.obsidian.md）を確認すると、
「Command line interface」や「CLI トグル」の項目は一切記載されていません。

Obsidian 本体は GUI アプリとして提供されており、コマンドラインから直接ノートを操作する機能は公式には実装されていません。そのため、ターミナル経由での操作を行う場合は コミュニティが作成したプラグイン を利用する必要があります。代表的なのが 「Obsidian CLI」（GitHub: https://github.com/obsidianmd/obsidian-cli）です。

2. 「Obsidian CLI」プラグインの概要と入手方法

項目 内容
提供形態 Obsidian の公式プラグインマーケットプレイスに登録されているサードパーティ製プラグイン
主な機能 list, create, search, open などのコマンドで Vault 内の Markdown ファイルを操作
インストール手順 1. Obsidian を起動
2. Settings → Community plugins → Browse
3. 「Obsidian CLI」を検索して Install、続いて Enable
公式サポート プラグインの作者が GitHub の Issue や Wiki で情報を提供。Obsidian 本体のサポート対象外

※プラグインは常に最新版を使用し、セキュリティ上の問題が報告された場合は速やかにアップデートしてください。

3. プラグイン有効化後の「CLI トグル」設定は不要

プラグインを Enable しただけでコマンドラインから obsidian コマンドが使用可能になります。
公式ドキュメントに記載されているような Settings の「Command line interface」スイッチは 存在しません。従って、以下の手順は不要です。

誤情報修正：Catalyst ライセンスや Insider ビルドを取得しなくても CLI は利用できません（プラグインが有効であれば無料で使用可能）。

4. OS 別に必要な PATH 登録手順

Obsidian CLI はプラグインのインストール時に 実行ファイルへのシンボリックリンク を自動作成します。ただし、OS やインストール方法によってはパスが通っていないことがあります。以下に主要 OS で確実に obsidian コマンドを認識させる手順を示します。

4.1 Windows（10/11）

  1. インストール場所の確認
    デフォルトでは %APPDATA%\Obsidian\plugins\obsidian-cli\dist\obsidian.exe に配置されます。

  2. パスへ追加（ユーザー環境変数）
    powershell
    $cliPath = "$env:APPDATA\Obsidian\plugins\obsidian-cli\dist"


    管理者権限は不要です。

  3. 反映確認
    新しい PowerShell/コマンドプロンプトを開き、obsidian --version が表示されれば完了。

4.2 macOS（Intel / Apple Silicon）

  1. プラグインの実体パス
    /Users/<user>/Library/Application Support/Obsidian/plugins/obsidian-cli/dist/obsidian

  2. シンボリックリンク作成（/usr/local/bin が PATH に入っている前提）
    bash
    ln -s "$HOME/Library/Application Support/Obsidian/plugins/obsidian-cli/dist/obsidian" /usr/local/bin/obsidian

  3. シェル設定の更新（zsh がデフォルトの場合）
    bash
    source ~/.zshrc
    obsidian --help でヘルプが表示されれば成功です。

4.3 Linux（Ubuntu/Debian 系を想定）

  1. 実体パス
    $HOME/.config/Obsidian/plugins/obsidian-cli/dist/obsidian

  2. ユーザーのローカル bin にリンク
    bash
    mkdir -p "$HOME/.local/bin"
    ln -s "$HOME/.config/Obsidian/plugins/obsidian-cli/dist/obsidian" "$HOME/.local/bin/obsidian"

  3. PATH へ追加（~/.profile が読み込まれることを前提）
    bash
    echo 'export PATH="$PATH:$HOME/.local/bin"' >> ~/.profile
    source ~/.profile

5. 基本コマンドと代表的オプション

コマンド 主な用途 主なオプション例
obsidian list Vault 内のファイル一覧取得 --vault "<Vault名>", --folder "Notes/Projects", --output json
obsidian create <path> 新規 Markdown ファイル作成 --title "会議メモ {{date:YYYY-MM-DD}}", --template "Templates/meeting.md"
obsidian search "<query>" キーワード検索（全文検索） --regex "^##\s", --limit 20, --output json
obsidian open <path> OS のデフォルトビューアでファイルを開く --vault "My Vault"
obsidian status プラグインと Obsidian アプリの連携状態確認 なし

使用例

6. トラブルシューティング

症状 原因の可能性 対処法
obsidian: command not found PATH に登録されていない 上記 OS 別手順でシンボリックリンク／環境変数を確認
Error: Obsidian is not running プラグインがバックエンドのアプリと通信できていない ターミナルで obsidian status を実行し、起動していなければ手動で Obsidian アプリを開く
権限エラー (Permission denied) 実行ファイルへの書き込み権が不足 必要に応じて所有者変更（例: sudo chown $(whoami) /usr/local/bin/obsidian）または管理者権限でリンク作成
ログが残らない／エラーメッセージが不明 プラグインのデバッグモード未有効 環境変数 OBSIDIAN_CLI_DEBUG=1 を設定して再実行し、標準出力に詳細情報を取得

ログファイル位置（プラグイン側の仕様）

OS ログパス
Windows %APPDATA%\Obsidian\plugins\obsidian-cli\logs\cli.log
macOS / Linux $HOME/.config/Obsidian/plugins/obsidian-cli/logs/cli.log

ログを見るには type（Windows）または cat（macOS/Linux）で内容を確認してください。

7. セキュリティ上のベストプラクティス

  1. 最小権限で実行
  2. 基本的に管理者 / root 権限は不要です。

  3. setx（Windows）や sudo ln -s のようなコマンドは、システム全体に影響を与える可能性があるため 必要最小限 に留めます。

  4. スクリプトのレビュー

  5. CLI は外部から呼び出せるため、任意のシェルスクリプトがノートを書き換えるリスクがあります。

  6. 自動化スクリプトは Git などでバージョン管理し、変更履歴を必ず確認してください。

  7. プラグイン更新の徹底

  8. 開発者が脆弱性修正や機能改善を行ったらすぐにアップデートします。Obsidian の Community plugins ページで「Check for updates」を定期的に実施しましょう。

  9. Vault のバックアップ

  10. CLI が大量のファイル操作を行う前に、外部ストレージやクラウド（例: Dropbox, OneDrive）へ自動バックアップを設定しておくと安心です。

8. まとめ ― 実際に使えるまでのフロー

  1. Obsidian の Community plugins から「Obsidian CLI」をインストールし有効化
  2. OS に合わせて PATH 登録（Windows は setx、macOS はシンボリックリンク、Linux は $HOME/.local/bin）
  3. obsidian --help が表示されたら 基本コマンド（list, create, search, open）を試す
  4. エラーが出たら トラブルシューティング の表を参照し、ログ (cli.log) を確認
  5. スクリプト化・自動化する際は 最小権限 と コードレビュー を徹底

上記手順に沿って設定すれば、ターミナルから Obsidian のノートを検索したり新規作成したりできるようになります。公式機能ではない点を常に意識しつつ、プラグインのアップデートとセキュリティ対策を忘れずに活用してください。

スポンサードリンク

-Obsidian