Obsidian CLI

保管庫をコマンドしよう。

Obsidianでできることはすべて、コマンドラインから実行できます。

ターミナル
# 今日のデイリーノートを開く
obsidian daily

# 保管庫を検索
obsidian search query="会議メモ"

# デイリーノートにタスクを追加
obsidian daily:append content="- [ ] 食料品を買う"

ユースケース

Obsidian CLIは、プレーンテキストのためのプログラマブルな実験場です。

開発
プラグインやテーマをより速く構築。ターミナルを離れずに、コード編集、再読み込み、テスト、デバッグが行えます。
共同作業
ドキュメントをデプロイし、共有保管庫をサーバーに同期して、チームのツールチェーンにObsidianを統合できます。
自動化
cronジョブ、シェルスクリプト、カスタム連携でワークフローを自在に組み立てましょう。スクリプト化できることなら、実行できます。
試してみる
保管庫をプログラムから読み取り、検索し、書き込めます。エージェント型ツールに保管庫とやり取りする機能を提供します。

はじめる

Obsidian CLIをインストール

01

Obsidianをアップデート

最新のObsidianインストーラーをダウンロードしてください。 ダウンロード →

02

CLIを有効化

設定一般コマンドラインインターフェース を有効にします。

03

CLIを登録

画面の指示に従って、CLIをシステムのPATHに追加します。変更を反映するにはターミナルを再起動してください。

登録すると、~/.zprofile を介して Obsidian のバイナリが PATH に追加されます。bash や fish を使っている場合は、そのパスをシェル設定に手動で追加してください。

~/.zprofile
export PATH="$PATH:/Applications/Obsidian.app/Contents/MacOS"

インストーラーは Obsidian.exe とあわせて Obsidian.com ターミナルリダイレクターを追加します。これは、Obsidian がGUIアプリとして動作するために必要です。

AppImage: /usr/local/bin/obsidian にシンボリックリンクが作成されます(sudoが必要)。sudoに失敗した場合は ~/.local/bin にフォールバックします。

Flatpak: シンボリックリンクは自動的に作成されます。失敗した場合は、Flatpak export を指すものを手動で作成してください。

最初のコマンドを実行

インストールが完了したら、すぐに使い始められます。なお、Obsidianアプリが起動している必要があります。

コマンドを実行

ターミナル
# ヘルプを表示
obsidian help

TUIモードを使う

ターミナル
# TUIを起動(オートコンプリート付き)
obsidian

使用例

動作を見る

日々のノート作成から開発者向けの自動化まで、実践的な例をチェックしましょう。

ターミナル
# 今日のデイリーノートを開く
obsidian daily

# デイリーノートにタスクを追加
obsidian daily:append content="- [ ] 食料品を買う"

# 保管庫を検索
obsidian search query="会議メモ"

# 現在のファイルを読む
obsidian read

# デイリーノートのすべてのタスクを一覧表示
obsidian tasks daily

# テンプレートから新しいノートを作成
obsidian create name="パリ旅行" template=旅行

# すべてのタグを出現頻度つきで表示
obsidian tags counts

# ファイルの2つのバージョンを比較
obsidian diff file=README from=1 to=3
ターミナル
# DevToolsを開く
obsidian devtools

# 開発中のプラグインを再読み込み
obsidian plugin:reload my-plugin

# アプリのスクリーンショットを撮影
obsidian dev:screenshot file=shot.png

# JavaScriptを実行
obsidian eval "app.vault.getFiles().length"

# JSエラーを確認
obsidian dev:errors

# CSSプロパティを調査
obsidian dev:css selector=".workspace"

# DOM要素を照会
obsidian dev:dom selector=".nav"
ターミナル
#!/bin/bash
# 朝のルーティンの自動化

# 今日のデイリーノートを開く
obsidian daily

# 定型タスクを追加
obsidian daily:append content="- [ ] 受信箱を確認"
obsidian daily:append content="- [ ] カレンダーを確認"

# 最近のファイルをクリップボードにコピー
obsidian files sort=modified limit=5 --copy

# 未解決のリンクを確認
obsidian unresolved

# 特定の保管庫を検索してJSONとしてエクスポート
obsidian search query="status::active" vault="ノート" format=json

ホットキー

キーボードショートカット

便利なショートカットと自動補完をTUIに標準搭載。

ナビゲーション

左に移動 / Ctrl+B
右に移動 / Ctrl+F
行頭 Ctrl+A
行末 Ctrl+E
前の単語 Alt+B
次の単語 Alt+F

編集

行頭まで削除 Ctrl+U
行末まで削除 Ctrl+K
前の単語を削除 Ctrl+W / Alt+⌫
候補を受け入れる Tab
候補を閉じる Shift+Tab
最初の候補を受け入れる

一般

前のコマンド / Ctrl+P
次のコマンド / Ctrl+N
履歴を検索 Ctrl+R
キャンセル Escape
画面をクリア Ctrl+L
終了 Ctrl+C / Ctrl+D

同期

Headless Sync

GUIなしでObsidian Syncを実行できます。Obsidian Syncの速度、プライバシー、エンドツーエンド暗号化をそのままに、あらゆるサーバーや自動化環境で利用できます。

  • リモートバックアップを自動化。
  • Webサイトの公開を自動化。
  • フルコンピューターへのアクセスなしで、エージェント型ツールに保管庫へのアクセスを提供します。
  • 共有チーム保管庫を、ほかのツールにデータを渡すサーバーへ同期します。
  • 定期的な自動化を実行 — デイリーノートを週次サマリーに集約したり、自動タグ付けしたり、さらに多くのことが可能です。

はじめる

Obsidian CLIのインストール方法と使い方を学びましょう。