CLI란 무엇인가요?

Obsidian CLI는 터미널에서 Obsidian 볼트를 직접 제어할 수 있는 커맨드라인 인터페이스입니다. 노트 생성·수정·검색부터 동기화, 퍼블리시, JavaScript 실행까지 100개 이상의 명령어를 제공합니다.

시작 전 확인사항

CLI를 사용하기 전에 아래 조건을 모두 충족해야 합니다.

• 📦
  Obsidian v1.12 이상 + Installer v1.11.7 이상 — Help → About에서 버전 확인. 인스톨러 버전은 별도로 표시됩니다.
• 🔑
  Catalyst 라이선스 필요 ($25 one-time) — Insider 기능이므로 Catalyst 구매 후 계정 연결이 필요합니다. obsidian.md에서 구매 가능.
• 🚀
  Obsidian 앱이 실행 중이어야 함 — CLI는 실행 중인 Obsidian 인스턴스와 통신합니다. 앱을 먼저 열어두세요.
• 💻
  지원 플랫폼: macOS, Windows, Linux — 각 플랫폼별 설치 방법이 다릅니다. 아래 설치 탭에서 확인하세요.

플랫폼별 설치 방법

운영체제를 선택하여 설치 단계를 확인하세요.

# 설치 확인
$ which obsidian
/usr/local/bin/obsidian
$ obsidian version

설치 검증 명령어

설치 후 아래 명령어로 정상 동작을 확인하세요.

$ obsidian version
Obsidian CLI 1.12.0
Obsidian 1.12.3 (Installer 1.11.7)

$ obsidian vault
Name:  My Vault
Path:  /Users/tagg/Documents/MyVault

$ obsidian files total
342

카테고리별 명령어

100개 이상의 명령어가 카테고리별로 정리되어 있습니다. obsidian help <command>로 상세 도움말을 확인하세요.

실전 사용 예제

자주 사용하는 패턴을 코드로 확인하세요.

$ obsidian create name="회의록" template="Meeting"

$ obsidian daily:append content="오늘의 할 일\n- [ ] 보고서 작성\n- [ ] 코드 리뷰"

$ obsidian search query="#project"
$ obsidian search query="#project" --format=paths

$ obsidian read file="Note Name"
$ obsidian read file="Note Name" --format=md

$ obsidian sync:status
Status:   synced
Files:    342 synced, 0 pending

$ obsidian eval code="app.vault.getFiles().length"
342

$ obsidian eval code="app.workspace.getActiveFile()?.basename"
"현재 열린 노트"

#!/bin/bash
# 매일 아침 데일리 노트에 날씨 추가하기
WEATHER=$(curl -s "wttr.in/Seoul?format=3")
obsidian daily:append content="## 날씨\n$WEATHER"

인터랙티브 터미널 UI

obsidian을 인수 없이 단독 실행하면 인터랙티브 TUI 환경으로 진입합니다. 명령어 자동완성, 히스토리 탐색, 실시간 검색을 지원합니다.

--format 옵션

대부분의 명령어는 --format 플래그로 출력 형식을 지정할 수 있습니다. 기본값은 명령어마다 다릅니다.

# JSON 출력 (파이프라인 활용)
$ obsidian files --format=json | jq '.[] | select(.tags | contains(["project"]))'

# CSV로 스프레드시트 활용
$ obsidian files --format=csv > vault-files.csv

# 경로만 추출하여 다른 명령어와 조합
$ obsidian search query="#review" --format=paths | wc -l

자주 발생하는 문제

문제가 발생하면 아래 표를 참고하세요.