Перейти к содержимому
Авторский вебсайт. Ошибки и проблемы гарантированы❗
Киберинженерия
Инженерия
Obsidian
Интерфейс
Команды

Командный интерфейс

Ключевые понятия

Интерфейс командной строки — разновидность интерфейса в котором человек взаимодействует с устройством посредством клавиатуры и терминала.

Использовать интерфейс командной строки

В интерфейсте командной строки больше возможностей управления приложением Obsidian, чем в графическом интерфейсе.

Подсказка

Для оперирования в интерфейсе командной строки следует запустить приложение Obsidian. Если этого не сделать, то первая же команда в любом случае запустит Obsidian.

Существует два режима интерфейса командной строки:

  • команда;
  • терминальный интерфейс.

Вызвать команду

Выполнить команду получения справки:

obsidian help

Примеры применения команд:

# Открыть сегодняшнюю ежедневную заметку
obsidian daily

# Добавить задание в ежедневную заметку
obsidian daily:append content="- [ ] Купить продукты"

# Найти протоколы совещаний
obsidian search query="Протокол совещания"

# Прочитать текущий в редакторе файл
obsidian read

# Вывести список всех заданий из ежедневной заметки
obsidian tasks daily

# Создать новую заметку по шаблону
obsidian create name="Поездка в деревню" template=Travel

# Узнать количество тегов в заметках
obsidian tags counts

# Сравнить две версии файла
obsidian diff file=README from=1 to=3

Вызвать терминальный интерфейс

Для открытия терминального интерфейса (Terminal User Interface, TUI) достаточно набрать команду obsidian, а затем можно в отдельных строках вызывать дополнительные команды и флаги. Например:

obsidian     # Начало серии команд
help
help links
^C           # Конец серии команд

Для выхода из серии команд достаточно нажать сочетание клавиш <Ctrl+C>.

Синтаксис команды

Команда — текстовая инструкция, которая посредством терминала операционной системы передаёт приложению строку кода определённого синтаксиса.

Синтаксис команды:

obsidian <хранилище> <действие> <параметр> <флаг>

Команда терминального интерфейса содержит:

  • наименование приложения, вызывающее интерфейс этого приложения;
  • наименование хранилища;
  • действие;
  • параметры действия;
  • флаг действия.

Наименование приложения — это непосредственно obsidian.

Наименование хранилища, указанное при создании этого хранилища. Указывают после наименования приложения. Если хранилище не указано, значит это по умолчанию текущее хранилище.

Действие ставят сразу после наименования хранилища. Оно состоит из одного слова или связки через двоеточие. Пример действия: read (прочитать), create (создать), search (поиск).

Параметр — это переменная, которая принимает указанные значения. Синтаксис параметра:

Пример ввода параметров команды:

# Для параметров, не содержащих пробелы
parameter=value
параметр=значение

# Для параметров, содержащих пробелы
parameter="value with spaces" 
параметр="значение с пробелами"

_ Флаг_ — абстрактный переключатель без значения. Например, флаг open означает «открыть заметку», а флаг overwrite — перезаписать заметку.

Пример ввода флагов команды:

# Создать заметку с идентификатором файла «Заметка» и содержанием «Привет».
# После чего открыть и заменить коментент.
obsidian create name=Заметка content="Привет" open overwrite

Совет

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

Примеры команд:

# Открыть заметку. Действие read. Параметр file=«»
obsidian read file="Моя заметка"

# Создать новую заметку. Действие create. Параметры name="" и content="". Флаг silent.
obsidian create name="План на неделю" content="# Главное" silent

# Поиск текста. Действие search. Параметры query="" и limit=""
obsidian search query="идея проекта" limit=10

# Добавить задание в список ежедневной заметки. Действие daily:append. Параметр content=""

# Изменить метаданные. Действие property:set

Примеры часто применяемых команд:

obsidian read file="Моя заметка"
obsidian create name="Новая заметка" content="# Заголовок" template="Название шаблона" silent
obsidian append file="Моя заметка" content="Новая строка текста"
obsidian search query="строка запроса" limit=10
obsidian daily:read
obsidian daily:append content="- [ ] Новое задание"
obsidian property:set name="статус" value="выполнено" file="Моя заметка"
obsidian tasks daily todo
obsidian tags sort=count counts
obsidian backlinks file="Моя заметка"

Список команд

К сведению

При необходимости применения команд проектировщиков, читайте официальную документацию Obsidian.

Ниже приведён список команд в алфавитном порядке, предназначенных пользователю приложения Obsidian:

Команды управления базой данных

Команды управления базой данных:

  • bases — вывести список всех файлов с расширением  .base в хранилище;
  • base:views — вывести список представления данных в базе данных текущей заметки;
  • base:create — добавить элемент в текущую базу данных:
    • file=<name> — файл с указанным наименованием;
    • path=<path> — указать путь к файлу;
    • view=<name> — указать наименование представления;
    • name=<name> — переименовать файл базы данных;
    • content=<text> — указать добавляемый в базу контент;
    • open — открыть файл после создания;
    • newtab — открыть файл в новой вкладке;
  • base:query — ввести запрос к базе данных в поисках элементов:
    • file=<name> — по указанному наименованию файла базы данных;
    • path=<path> — указать путь к файлу запроса;
    • view=<name> — указать представление в файле запроса;
    • format=json|csv|tsv|md|paths — указать формат вывода данных запроса (по умолчанию: json).

Команды управления вкладками

Команды управления вкладками:

  • tabs — вывести список текущих вкладок: 
    • ids — вывести идентификаторы (ID) вкладок;
  • tab:open — открыть новую вкладку:
    • group=<id> — указать идентификатор (ID) группы вкладок;
    • file=<path> — указать путь к файлу;
    • view=<type> — указать тип представления вкладки;
  • recents — вывести список недавно используемых вкладок: 
    • total — вывести количество недавно используемых вкладок.

Команды управления ежедневными заметками

Команды управления ежедневными заметками:

  • daily — открыть ежедневную заметку:
    • paneType=tab|split|window — открыть во вкладке, в разделённой вкладке, в отдельном окне;
  • daily:path — вывести путь к ежедневной заметке даже если файл ещё не создан;
  • daily:read — вывести содержимое ежедневной заметки;
  • daily:append — добавить указанный контент в конец ежедневной заметки: 
    • content=<text> — фрагмент текста;
    • paneType=tab|split|window — открыть во вкладке, в разделённой вкладке, в отдельном окне;
    • inline — добавить контент без перевода строки;
    • open — открыть файл после добавления контента;
  • daily:prepend — добавить указанный контент в начало ежедневной заметки:  
    • content=<text> — фрагмент текста;
    • paneType=tab|split|window — открыть во вкладке, в разделённой вкладке, в отдельном окне;
    • inline — добавить контент без перевода строки;
    • open — открыть файл после добавления контента;

Команды управления заданиями

Команды управления заданиями:

  • tasks —  вывести список всех заданий из файлов хранилища;
    • file=<name> — вывести список заданий из указанного файла;
    • path=<path> — указать путь к файлу;
    • status="<char>" — вывести список заданий с указанным символом статуса;
    • total — вывести общее количество заданий;
    • done — вывести список выполненных заданий;
    • todo — вывести список невыполненных заданий;
    • verbose — вывести номера строк файлов;
    • format=json|tsv|csv — вывести в указанном формате (по умолчанию:text);
    • active — вывести список заданий текущего файла;
    • daily — вывести список заданий ежедневной заметки.

Примеры применения команды tasks:

# Список невыполненных заданий в хранилище
tasks todo

# Список выполненных заданий в указанном файле
tasks file=Recipe done

# Список заданий сегодняшней ежедневной заметки
tasks daily

# Подсчёт заданий ежедневной заметки
tasks daily total

# Список заданий с отображением пути к файлу и номеров строк
tasks verbose

# Список заданий с указанным статусом
tasks 'status=?'
  • task — вывести задание текущего файла:
    • ref=<path:line> — указать ссылку на задание (путь:строка);
    • file=<name> — вывести список заданий из указанного файла;
    • path=<path> — указать путь к файлу;
    • status="<char>" — установить символ статуса;
    • done — отметить как выполненное задание;
    • todo — отметить как невыполненное задание;
    • line=<n> — указать номер строки;
    • toggle — переключить статус;
    • daily — вывести список заданий ежедневной заметки.

Примеры применения команды task:

# Показать сведения о задании
task file=Recipe line=8
task ref="Recipe.md:8"

# Переключить выполнение задания
task ref="Recipe.md:8" toggle

# Переключить задание ежедневной заметке
task daily line=3 toggle

# Установить статус задания
task file=Recipe line=8 done      # → [x]
task file=Recipe line=8 todo      # → [ ]
task file=Recipe line=8 status=-  # → [-]

# Отметить выполнение задания ежедневной заметки
task daily line=3 done

Команды управления закладками

Команды управления закладками:

  • bookmarks — вывести список закладок:
    • total — вывести количество закладок;
    • verbose — вывести типы закладок;
    • format=json|tsv|csv — вывести в указанном формате (по умолчанию tsv);
  • bookmark — добавить закладку:
    • file=<path> — добавить в указанный файл;
    • subpath=<subpath> — добавить в указанный заголовок или блок внутри файла;
    • folder=<path> — добавить к указанному каталогу;
    • search=<query> — добавить в закладки поисковый запрос;
    • url=<url> — добавить в закладики URL;
    • title=<title> — добавить название закладки.

Команды управления историей файлов

Команды управления историей локальных файлов:

  • history — вывести на экран список версий текущего файла;
    • file=<name> — вывести список версий указанного файла;
    • path=<path> — указать путь к файлу.
  • history:list  — вывести историю локальных файлов;
  • history:read — вывести последнюю версию текущего файла:
    • file=<name> — вывести последнюю версию указанного файла;
    • path=<path> — указать путь к файлу;
    • version=<n> — вывести версию по указанному номеру (по умолчанию: 1);
  • history:restore — восстановить версию локального файла:
    • file=<name> — восстановить версию указанного файла;
    • path=<path> — указать путь к восстанавливаемому файлу;
    • version=<n> — восстановить указанный номер версии;версии
  • history:open — открыть файл с восстановленной версией:
    • file=<name> — открыть указанный файл;
    • path=<path> — указать путь к открываемому файлу.

Команды управления каталогами

Команды управления каталогами:

  • folder path=<path> — вывести метаданные указанного каталога: 
    • info=files|folders|size — вывести количество файлов (files), количество подкаталогов (folders), размер (size).
  • folders — вывести список каталогов в текущем хранилище: 
    • folder=<path> — вывести список подкаталогов в указанном каталоге;
    • total — вывести количество каталогов

Команды управления метаданными

Команды управления метаданными:

  • aliases — вывести список псевдонимов в текущем хранилище:
    • file=<name> — вывести псевдонимы для указаного файла;
    • path=<path> — указать путь к файлу;
    • total — вывести общее количество псевдонимов;
    • verbose — показать пути к файлам;
    • active — показать псевдонимы текущего файла;
  • properties —  вывести список метаданных в файлах хранилища:
    • file=<name> — вывести метаданные для указаного файла;
    • path=<path> — указать путь к файлу;
    • name=<name> — вывести количество использований указанного поля метаданных в файлах хранилища;
    • sort=count — отсортировать по количеству использований метаданных (по умолчанию по наименованию);
    • format=yaml|json|tsv — вывести в указанном формате (по умолчанию yaml);
    • total — вывести общее количество метаданных;
    • counts — вывести количество вхождений метаданных;
    • active — показать метаданные текущего файла;
  • property:set —  добавить метаданные в текущий файл:
    • name=<name> — указать название поля метаданных (обязательный параметр);
    • value=<value> — указать значение поля метаданных (обязательный параметр);
    • type=text|list|number|checkbox|date|datetime — тип значения метаданных (текст, список, число, проверочный список, дата, дата и время);
    • file=<name> — указать наименование файла;
    • path=<path> — указать путь к файлу;
  • property:remove — удалить метаданные в текущий файл: 
    • name=<name> — указать название поля метаданных (обязательный параметр);
    • file=<name> — указать наименование файла;
    • path=<path> — указать путь к файлу;
  • property:read — вывести значение метаданных текущего файла:
    • name=<name> — указать название поля метаданных (обязательный параметр);
    • file=<name> — указать наименование файла;
    • path=<path> — указать путь к файлу;

Команда управления оглавлением

Команда управления оглавлением

  • outline — вывести оглавление текущего файла: 
    • file=<name> — вывести оглавление для указаного файла;
    • path=<path> — указать путь к файлу;
    • format=json|tsv|csv — вывести в указанном формате (по умолчанию иерархия);
    • total — вывести общее количество заголовков оглавления;

Команды управления палитрой

Команды управления плагином палитры команд:

  • commands — вывести список доступных идентификаторов команд:
    • filter=<prefix> — фильтровать по префиксу идентификатора (Id)
  • command — выполнить указаную команду:
    • id=<command-id> — обязательно указать идентификатор команды (Id);

Команды управления плагинами

Команды управления плагинами:

  • plugins — вывести список установленных плагинов для текущего хранилища; 
    • filter=core|community — фильтровать либо по встроенным, либо по плагинами сообщества;
    • versions — вывести номер версии плагина;
    • format=json|tsv|csv — вывести в указанном формате (по умолчанию tsv);
  • plugins:enabled — вывести список включённых плагинов:
    • filter=core|community — фильтровать либо по встроенным, либо по плагинами сообщества;
    • versions — вывести номер версии плагина;
    • format=json|tsv|csv — вывести в указанном формате (по умолчанию tsv);
  • plugins:restrict —  проверить, включён ли безопасный режим (без плагинов сообщества):
    • on — включить безопасный режим;
    • off — отключить безопасный режим, дать возможность устанавливать плагины сообщества;
  • plugin —  вывести сведения о плагине:
    • id=<plugin-id> — указать идентификатор плагина (обязательный параметр);
  • plugin:enable — включить плагин; 
    • id=<plugin-id> — указать идентификатор плагина (обязательный параметр);
    • filter=core|community — указать тип плагина: встроенный (core) или плагин сообщества (community);
  • plugin:disable — отключить плагин: 
    • id=<plugin-id> — указать идентификатор плагина (обязательный параметр);
    • filter=core|community — указать тип плагина: встроенный (core) или плагин сообщества (community);
  • plugin:install — установить плагин сообщества: 
    • id=<plugin-id> — указать идентификатор плагина (обязательный параметр);
    • enable — включить плагин после установки:
  • plugin:uninstall — деинсталлировать плагин сообщества: 
    • id=<plugin-id> — указать идентификатор плагина (обязательный параметр);
  • plugin:reload — перезагрузить плагин (команда полезная для создателей плагинов): 
    • id=<plugin-id> — указать идентификатор плагина (обязательный параметр);

Команды управления поиском

Команды управления поиском:

  • search —  найти строку текста в файлах текущего хранилища:
    • query=<text> — указать строку текста в запросе;
    • path=<folder> — ограничить поиск указанным каталогом;
    • limit=<n> — ограничить количество файлов для поиска;
    • format=text|json — вывести в указанном формате (по умолчанию text);
    • total — вывести указанное количество найденных соответствий;
    • case — указать чувствительность запроса к регистру глифов;
  • search:context — найти строку текста в контексте и вывести в формате путь:строка: текст.
    • query=<text> — указать строку текста в запросе;
    • path=<folder> — ограничить поиск указанным каталогом;
    • limit=<n> — ограничить количество файлов для поиска;
    • case — указать чувствительность запроса к регистру глифов;
    • format=text|json — вывести в указанном формате (по умолчанию text);
  • search:open —  начать поиск текста в поисковом запросе:
    • query=<text> — указать строку текста в запросе;

Команды управления приложением

Интерфейс командной строки содержит следующие общие команды управления приложением:

  • help — вывыести на экран список всех доступных команд;
    • help <command> — вывести справку указанной команды;
  • version — вывести номер установленной версии Obsidian;
  • reload — перезагрузить приложение;
  • restart — перезапустить приложение.

Команды управления рабочей средой

Команды управления рабочей средой:

  • workspace — вывести структуру рабочей среды:
    • ids — вывести идентификаторы (ID) элементов рабочей среды;
    • workspaces — вывести список рабочих сред: 
    • total — вывести общее количество сохранённых рабочих сред;
  • workspace:save — сохранить текущую компоновку рабочей среды:
    • name=<name> — указать наименование сохраняемой рабочей среды;
  • workspace:load — загрузить сохранённую рабочую среду: 
    • name=<name> — обязательно указать название рабочей среды;
  • workspace:delete — удалить сохранённую рабочую среду: 
    • name=<name> — обязательно указать название рабочей среды;

Команда подсчёта символов и слов

Команда посчёта символов и слов в файле (необходимо включить встроенный плагин «Счётчик слов»):

  • wordcount — вывести количество символов и слов в текущем файле: 
    • file=<name> — указать наименование файла;
    • path=<path> — указать путь к файлу;
    • words — вывести количество слов в файле;
    • characters — вывести количество символов в файле;

Команды управления сочетаниями клавиш

Команды управления сочетаниями клавиш:

  • hotkeys — вывести список всех сочетаний клавиш:
    • total — вывести количество используемых сочетаний клавиш;
    • verbose — вывести сочетания, введённые пользователем;
    • format=json|tsv|csv — вывести в указанном формате (по умолчанию tsv);
  • hotkey — вывести сочетание клавиш:
    • id=<command-id> — вывести сочетание клавиш для указанной команды (идентификатор Id обязателен);
    • verbose — вывести сочетание для данной команды, введённое пользователем;

Команда сравнения версий файла

Команда сравнения версий файла:

  • diff — сравнить две версии файла:
    • file=<name> — версии указанного файла; -path=<path> — указать путь к файлу;
    • from=<n> — номер одной из сравниваемых версий;
    • to=<n> — номер другой из сравниваемых версий;
    • filter=local|sync — отфильтровать либо локальные версии (local), либо синхронизированные версии (sync).
# Список всех версий текущего файла
diff

# Список всех версий конкретного файла
diff file=Recipe

# Сравнить текущую версию файла с предыдущей версией
diff file=Recipe from=1

# Сравнить две указанные версии
diff file=Recipe from=2 to=1

# Показать только синхронизированные (Sync) версии
diff filter=sync

Команды управления ссылками

Команды управления ссылками:

  • backlinks — вывести список обратных ссылок на текущий файл:
    • file=<name> — вывести список обратных ссылок на указаный файл;
    • path=<path> — указать путь к файлу;
    • counts — вывести количество обратных ссылок;
    • total — вывести общее количество обратных ссылок
    • format=json|tsv|csv # формат вывода (по умолчанию: tsv)
  • links — вывести список ссылок в текущем файле: 
    • file=<name> — вывести список ссылок в указаном файле;
    • path=<path> — указать путь к файлу;
    • total — вывести общее количество ссылок;
  • unresolved — вывести список пустых ссылок на несуществующие файлы хранилища:
    • total — вывести общее количество пустых ссылок;
    • counts — вывести количество обратных ссылок;
    • verbose — вывести подробный список: место, количество, файлы;
    • format=json|tsv|csv — вывести в указанном формате (по умолчанию tsv);
  • orphans — вывести список сиротливых файлов без входящих ссылок:
    • total — вывести общее количество сиротливых файлов;
  • deadends — вывести список тупиковых файлов без исходящих ссылок:
    • total — вывести общее количество тупиковых файлов;

Команды управления тегами

Команды управления тегами:

  • tags — вывести список тегов файлов хранилища; 
    • file=<name> — указать наименование файла;
    • path=<path> — указать путь к файлу;
    • sort=count — сортировать по количеству использований;
    • total — вывести количество тегов;
    • counts — вывести количество вхождений каждого тега;
    • format=json|tsv|csv — указать формат вывода (по умолчанию tsv);
    • active — вывести теги текущего файла;
  • tag — вывести сведения о теге: 
    • name=<tag> — обязательно указать наименование тега;
    • total — вывести количество вхождений тега;
    • verbose — вывести список файлов и количество вхождений тега.

Команда управления уникальным идентификатором

Совет

Для создания файла с уникальным идентификатором включите встроенный плагин «Уникальный идентификатор».

  • unique — создать заметку с уникальным идентификатором файла: 
    • name=<text> — указать наименование заметки;
    • content=<text> — указать текст заметки;
    • paneType=tab|split|window — указать место открытия заметки (новая вкладка, разделённая вкладка, окно);
    • open — открыть заметку после создания файла.

Команды управления файлами

Команды управления файлами:

  • file — вывести метаданные текущего файла:
    • file=<name> — вывести метаданные указанного файла;
    • path=<path> — вывести метаданные файла по указанному пути/

Пример вывода метаданных команды file:

path       Notes/Recipe.md
name       Recipe
extension  md
size       18328
created    1789723818772
modified   1789762496891
  • files — вывести список файлов в текущем хранилище:  
    • folder=<path> — вывести список файлов в указанном каталоге;
    • ext=<extension> — вывести список файлов указанного формата;
    • total — вывести общее количество файлов в хранилище.
  • open — открыть файл: 
    • file=<name> — открыть указанный файл;
    • path=<path> — указать путь к открываемому файлу;
    • newtab — открыть файл в новой вкладке;
  • create — создать или пересоздать файл: 
    • name=<name> — создать файл с указанным наименованием;
    • path=<path> — указать путь к создаваемому файлу;
    • content=<text> — вставить контент в создаваемый файл;
    • template=<name> — создать файл по указанному шаблону;шаблон
    • overwrite — если файл существует, перезаписать его;
    • open — после создания открыть файл;
    • newtab — открыть созданный файл в новой вкладке;
  • read — вывести содержимое текущего файла: 
    • file=<name> — вывести содержимое указанного файла;
    • path=<path> — указать путь к открываемому файлу;
  • append — добавить фрагмент текста в конец текущего файла: 
    • file=<name> — добавить фрагмент к указанному файлу;
    • path=<path> — указать путь к файлу;
    • content=<text> — добавляемый фрагмент текста (обязательно);
    • inline — добавить без перевода строки;
  • prepend — добавить фрагмент текста в начало текущего файла:
    • file=<name> — добавить фрагмент к указанному файлу;
    • path=<path> — указать путь к файлу;
    • content=<text> — добавляемый фрагмент текста (обязательно);
    • inline — добавить без перевода строки;
  • move — переместить или переименовать текущий файл с автоматическим обновлением внутренних ссылок: 
    • file=<name> — переместить указанный файл;
    • path=<path> — указать путь к файлу;
    • to=<path> — указать путь к целевому каталогу перемещения;
  • rename —  переименовать текущий файл с сохранением формата и автоматическим обновлением внутренних ссылок:
    • file=<name> — переименовать указанный файл;
    • path=<path> — указать путь к файлу;
    • name=<name> — новое наименование файла;
  • delete — удалить текущий файл: 
    • file=<name> — удалить указанный файл;
    • path=<path> — указать путь к файлу;
    • permanent — не перемещать в корзину, а удалить навсегда.

Команды управления хранилищем

Команды управления хранилищем:

  • vault — вывести сведения о текущем хранилище;
    • info=name|path|files|folders|size — вывести только указанные сведения (наименование, путь, количество файлов, количество каталогов, объём);
  • vaults — вывести список всех хранилищ: 
    • total — вывести количество хранилищ;
    • verbose — добавить к выводу пути к хранилищам;
  • vault:open — переключить внимание терминала на другое хранилище, при этом открытое в приложении хранилище не будет переключено: 
    • name=<name> — обязательно указать название хранилища;

Команды управления шаблонами

Команды управления шаблонами:

  • templates — вывести список шаблонов из каталога шаблонов;
    • total —- вывести количество шаблонов в каталоге шаблонов;
  • template:read —  вывести контент шаблона:
    • name=<template> — обязательно указать наименование шаблона;
    • title=<title> — установить заголовок шаблона;
    • resolve — присвоить значения переменным шаблона;
  • template:insert — вставить шаблон в текущий файл: 
    • name=<template> — обязательно указать наименование шаблона;

Примечание

Параметр resolve присваивает значения переменным {{date}}, {{time}}, {{title}}.

Совет

Для создания файла и одновременной вставки в него шаблона используйте команду create path=<path> template=<name>.

Сопровождение командного интерфейса

Включить интерфейс командной строки

Для того, чтобы включить интерфейс командной строки следует:

  1. Открыть «Настройки → Общие → Расширенные настройки → Интерфейс командной строки».
  2. Включить тумблер.

Выключить интерфейс командной строки

Для того, чтобы выключить интерфейс командной строки следует:

  1. Открыть «Настройки → Общие → Расширенные настройки → Интерфейс командной строки».
  2. Выключить тумблер.

Дополнительные сведения

Справка об интерфейсе командной строки.