Obsidian CLI

Используйте CLI obsidian для взаимодействия с запущенным экземпляром Obsidian. Требует, чтобы Obsidian был открыт.

Справочник команд

Выполните obsidian help, чтобы увидеть все доступные команды. Он всегда актуален. Полная документация: https://help.obsidian.md/cli

Синтаксис

Параметры принимают значение через =. Значения с пробелами в кавычках:

obsidian create name="My Note" content="Hello world"

Флаги — булевы переключатели без значения:

obsidian create name="My Note" silent overwrite

Для многострочного контента используйте \n для переноса строки и \t для табуляции.

Нацеливание на файл

Многие команды принимают file или path для указания файла. Без них используется активный файл.

• file=<name> — разрешается как вики-ссылка (только имя, без пути и расширения)
• path=<path> — точный путь от корня хранилища, напр. folder/note.md

Нацеливание на хранилище

Команды по умолчанию нацелены на последнее активное хранилище. Используйте vault=<name> первым параметром для конкретного хранилища:

obsidian vault="My Vault" search query="test"

Частые паттерны

obsidian read file="My Note"
obsidian create name="New Note" content="# Hello" template="Template" silent
obsidian append file="My Note" content="New line"
obsidian search query="search term" limit=10
obsidian daily:read
obsidian daily:append content="- [ ] New task"
obsidian property:set name="status" value="done" file="My Note"
obsidian tasks daily todo
obsidian tags sort=count counts
obsidian backlinks file="My Note"

Используйте --copy на любой команде, чтобы скопировать вывод в буфер обмена. silent — чтобы файлы не открывались. total на командах списка — чтобы получить количество.

Разработка плагинов

Цикл разработки/тестирования

После изменений кода плагина или темы следуйте этому процессу:

1. Перезагрузите плагин, чтобы подхватить изменения: obsidian plugin:reload id=my-plugin
2. Проверьте ошибки — если появились, исправьте и повторите с шага 1: obsidian dev:errors
3. Проверьте визуально скриншотом или осмотром DOM: obsidian dev:screenshot path=screenshot.png / obsidian dev:dom selector=".workspace-leaf" text
4. Проверьте вывод консоли на предупреждения или неожиданные логи: obsidian dev:console level=error

Дополнительные команды разработчика

Запуск JavaScript в контексте приложения:

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

Осмотр значений CSS:

obsidian dev:css selector=".workspace-leaf" prop=background-color

Переключение эмуляции мобильного:

obsidian dev:mobile on

Выполните obsidian help, чтобы увидеть дополнительные команды разработчика, включая управление CDP и отладчиком.