Obsidian CLI
Obsidianでできることはすべて、コマンドラインから実行できます。
# 今日のデイリーノートを開く
obsidian daily
# 保管庫を検索
obsidian search query="会議メモ"
# デイリーノートにタスクを追加
obsidian daily:append content="- [ ] 食料品を買う"
ユースケース
はじめる
設定 → 一般 で コマンドラインインターフェース を有効にします。
画面の指示に従って、CLIをシステムのPATHに追加します。変更を反映するにはターミナルを再起動してください。
登録すると、~/.zprofile を介して Obsidian のバイナリが PATH に追加されます。bash や fish を使っている場合は、そのパスをシェル設定に手動で追加してください。
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に標準搭載。
同期
GUIなしでObsidian Syncを実行できます。Obsidian Syncの速度、プライバシー、エンドツーエンド暗号化をそのままに、あらゆるサーバーや自動化環境で利用できます。