Scroll to navigation

CALIBREDB(1) calibre CALIBREDB(1)

NAME

calibredb - calibredb

calibredb команда [опции] [аргументы]


calibredb - это интерфейс командной строки к базе данных calibre. Он имеет несколько подкоманд, описанных ниже.

calibredb может использоваться для управления любой базой данных calibre указывается путем или Content server, работающим на локальном компьютере или через Интернет. Вы можете запустить calibre Content server с помощью команды caliber-server программу или в главной программе calibre нажмите Подключить/поделиться  →  Запустить Content server. Поскольку calibredb может вносить изменения в ваш calibre, сначала необходимо настроить аутентификацию на сервере. Есть два способа сделать это:

•
Если вы планируете подключаться только к серверу, работающему на том же компьютере,

можно просто использовать опцию --enable-local-write в контент-сервере, чтобы любая программа, включая calibredb, работала на локальном компьютере, для внесения изменений в данные calibre. При запуске сервера из главной программы calibre эта опция есть в Настройки →  Обмен через сеть →  Дополнительно.

•
Если вы хотите разрешить доступ через Интернет, вам следует настроить

учетные записи пользователей на сервере и использовать: option: --username и: option:` --password` options to: command: calibredb, чтобы предоставить доступ. Вы можете настроить аутентификацию пользователей для :command: calibre-server с помощью` --enable-auth` вариант и используя `` --manage-users '' для создания учетных записей пользователей. Если вы запускаете сервер из главной программы calibre, используйте Настройки →  Обмен по сети →  Требовать имя пользователя/пароль.

Чтобы подключиться к работающему серверу содержимого, передайте URL-адрес сервера в :option: параметр --with-library, см. документацию по этому параметру для деталей и примеров.

  • ГЛОБАЛЬНЫЕ НАСТРОЙКИ
  • list
  • add
•
ДОБАВЛЕНИЕ ИЗ ДИРЕКТОРИЙ

  • remove
  • add_format
  • remove_format
  • show_metadata
  • set_metadata
  • export
  • catalog
•
ОПЦИИ EPUB

  • saved_searches
  • add_custom_column
  • custom_columns
  • remove_custom_column
  • set_custom
  • restore_database
  • check_library
  • list_categories
  • backup_metadata
  • clone
  • embed_metadata
  • search

ГЛОБАЛЬНЫЕ НАСТРОЙКИ

показать это сообщение и выйти

Путь к библиотеке calibre. По умолчанию используется путь, сохранённый в настройках. Также можно подключиться к контент-серверу calibre для выполнения действий в удалённых библиотеках. Для этого используйте URL-адрес: http://hostname:port/#library_id, например, http://localhost:8080/#mylibrary. Library_id - это идентификатор библиотеки библиотеки, к которой вы хотите подключиться, на контент-сервере. Можно использовать специальное значение library_id для получения списка идентификаторов библиотеки, доступных на сервере. Подробнее о настройке доступа через контент-сервер см. в разделе https://manual.calibre-ebook.com/ru/generated/ru/calibredb.html.

Пароль для подключения к контент-серверу calibre. Чтобы прочитать пароль со стандартного ввода, используйте специальное значение: <stdin>. Чтобы прочитать пароль из файла, используйте: <f:/path/to/file> (т.е. <f: за ним следует полный путь к файлу и закрывающий >). Требуются угловые скобки в приведённом выше разделе, не забудьте экранировать их или использовать кавычки в вашем шелле.

Тайм-аут в секундах при подключении к библиотеке calibre по сети. По умолчанию - две минуты.

Имя пользователя для соединения с контент-сервером calibre

показать версию программы и выйти

LIST

calibredb список [options]


Список книг в базе данных calibre.

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Сортировать результаты по возрастанию

Поля, отображаемые при перечислении книг в базе данных. Должен быть разделённый запятыми список полей. Доступные поля: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, timestamp, title, uuid По умолчанию: title,authors. Специальное поле "all" можно использовать для выбора всех полей. В дополнение к встроенным полям, пользовательские поля также доступны как *field_name, например, для настраиваемого поля #rating, используйте имя: *rating

Генерирует вывод в формате JSON, более подходящем для машинного разбора. Игнорирует настройки ширины строки и разделителя.

Максимальное число результатов для отображения. По умолчанию: все

Максимальная ширина строки вывода. По умолчанию - размер экрана.

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

Фильтровать результаты запроса. С форматом запроса можно ознакомиться в соответствующей документации в руководстве пользователя. По умолчанию не фильтровать.

Разделитель полей. По умолчанию - пробел.

Поле, по которому сортировать результат. Доступные поля: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, timestamp, title, uuid По умолчанию: id

ADD

calibredb add [опции] файл1 файл2 файл3 …


Добавить указанные файлы как книги в базу данных. Также можно указать директории, смотрите связанные с ними опции ниже.

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Указать авторов добавляемых книг

Если будут найдены книги с похожими названиями и авторами, автоматически объединить входящие форматы (файлы) с существующими книжными записями. Значение "ignore" - повторяющиеся форматы отбрасываются. Значение "overwrite" - повторяющиеся форматы в библиотеке перезаписываются вновь добавленными файлами. Значение "new_record" - повторяющиеся форматы помещаются в новую запись книги.

Путь к обложке для использования в добавленной книге

Добавлять книги в базу данных, даже если они уже есть. Сравнение - по названиям книг и авторам. Параметр --automerge имеет приоритет.

Добавить пустую книгу (книгу без форматов)

Установить идентификаторы книги, например -I asin:XXX -I isbn:YYY

Указать ISBN добавляемых книг

Список языков через запятую (желательно использовать языкововую кодировку ISO639, хотя могут быть распознаны и некоторые обычные названия языков)

Указать серии добавляемых книг

Указать номер серии добавляемых книг

Указать теги добавляемых книг

Установить название добавляемой книги (книг)

ДОБАВЛЕНИЕ ИЗ ДИРЕКТОРИЙ

Опции для управления добавлением книг из директорий. По умолчанию добавляются только файлы с расширениями известных форматов электронных книг.

Шаблон имени файла (glob), файлы, соответствующие этому шаблону, будут добавлены при сканировании директорий, даже если файлы не являются известным типом электронной книги. Может быть указан несколько раз для нескольких шаблонов.

Шаблон имени файла, файлы, соответствующие этому шаблону, будут игнорироваться во время сканирования директорий. Может быть задан несколько раз для разных шаблонов. Например: *.pdf будет игнорировать все файлы pdf

Считать, что в каждой директории только одна логическая книга и все файлы — разные электронные форматы этой книги.

Обрабатывать рекурсивно

REMOVE

calibredb remove ids


Удалить книги, с определёнными идентификаторами из базы данных. Id должен быть разделенным запятыми списком идентификационных номеров (вы можете получить номера идентификаторов с помощью команды поиска). Например, 23,34,57-85 (при указании диапазона последнее число в диапазоне не включено).

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Не использовать корзину

ADD_FORMAT

calibredb add_format [опции] id файл_электронной_книги


Добавьте файл_электронной_книги в доступные форматы логической книги, определённой по id. Идентификатор можно получить с помощью команды search (искать). Если формат уже существует, он заменяется, если не указана опция --dont-replace (не заменять).

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Не заменять формат, если он уже существует

REMOVE_FORMAT

calibredb remove_format [параметры] id fmt


Удалить формат fmt из логической книги с идентификатором id. Получить id - команда search. fmt должен быть расширением файла, например LRF, или TXT, или EPUB. Если логическая книга не имеет доступного fmt не делать ничего.

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

SHOW_METADATA

calibredb show_metadata [параметры] id


Показывает метаданные, хранящиеся в базе данных calibre для книги, заданной идентификатором id. id - числовой идентификатор из команды search.

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Напечатать метаданные в OPF из (XML)

SET_METADATA

calibredb set_metadata [параметры] id [/путь/к/metadata.opf]


Задать метаданные, хранящиеся в базе данных calibre для книги, заданной идентификатором id из OPF-файла metadata.opf. id - числовой идентификатор из команды search. Вы можете получить представление о формате OPF используя параметр --as-opf в команде show_metadata. Также можно задать метаданные индивидуальных полей параметром --field. Если используется параметр --field, нет необходимости задавать файл OPF.

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Поле для установки. Формат название_поля:значение. Например: --field tags:tag1,tag2. Используйте --list-fields чтобы получить список названий полей. Вы можете указать эту настройку несколько раз для установки нескольких полей. Помните: для языков вы должны использовать ISO639 языковую кодировку (то есть en для English, fr для French и т.д.). Для идентификаторов, синтаксис --field identifiers:isbn:XXXX,doi:YYYYY. Для булевых (да/нет) полей используйте true и false или yes и no.

Список названий полей метаданных, которые могут быть использованы с опцией --field.

EXPORT

calibredb export [параметры] идентификаторы


Экспорт книг заданных идентификаторами (разделенный запятыми список) в файловую систему. Операция экспорта сохраняет все форматы книги, её обложку и метданные (в файле opf). Вы можете получить номера идентификаторов при помощи команды search.

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Экспортировать все книги в базу данных, игнорируя список id.

calibre преобразует все неанглийские символы в английские эквиваленты имен файлов. Это полезно при сохранении в устаревшую файловую систему без полной поддержки имен файлов Unicode. Указание этого переключателя отключит данный режим.

Обычно, calibre будет сохранять обложку в отдельном файле рядом с файлами электронной книги. Указание этого переключателя отключит данный режим.

По умолчанию calibre обновляет метаданные в сохранённых файлах в библиотеке. Может замедлить запись на диск. Указание этого переключателя отключит данный режим.

Обычно, calibre будет писать метаданные в отдельный файл OPF рядом с файлом электронной книги. Указание этого переключателя отключит данный режим.

Список форматов, разделенных запятыми, для сохранения для каждой книги. По умолчанию все доступные форматы сохраняются.

Прогресс отчёта

Заменить пробел символом подчёркивания.

Экспортировать все книги в одну директорию

Шаблон для управления названием файла и структурой папки с сохранёнными файлами. По умолчанию "{author_sort}/{title}/{title} - {authors}" будет сохранять книги в подпапку с именем автора и названиями файлов включающими название и автора. Доступные настройки: {author_sort, authors, id, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, tags, timestamp, title}

Формат отображения дат. %d - день, %b - месяц, %m - номер месяца, %Y - год. По умолчанию: %b, %Y

Экспортировать книги в указанную директорию. По умолчанию .

Преобразовать пути в нижний регистр.

CATALOG

calibredb catalog /path/to/destination.(csv|epub|mobi|xml...) [options]


Export a catalog in format specified by path/to/destination extension. Options control how entries are displayed in the generated catalog output. Note that different catalog formats support different sets of options. To see the different options, specify the name of the output file and then the --help option.

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Разделённый запятыми список идентификаторов из базы данных для каталога. Если указано, --search игнорируется. По умолчанию: all

Фильтровать результаты по поисковому запросу. О формате поискового запроса читайте в связанной с поиском документации в руководстве пользователя. По умолчанию: no filtering (не фильтровать)

Показать детальную информацию. Используется для отладки.

ОПЦИИ EPUB

Название сгенерированного каталога, используемого как название в метаданных. По умолчанию: 'My Books' Применяется к: AZW3, EPUB, MOBI форматам вывода

Создание перекрестных ссылок в разделе «Авторы» для книг с несколькими авторами. По умолчанию: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода

Сохранить вывод разных этапов конвейера конвертации в указанную директорию. Полезно для выявления этапа конвертации с ошибкой. По умолчанию: 'None' Применяется к: AZW3, EPUB, MOBI форматам вывода

Regex, описывающий теги для исключения в качестве жанров. По умолчанию: '[.+]|^+$' исключает теги в квадратных скобках, напр. '[Project Gutenberg]', и '+', умолчальный тег для чтения книг. Применяется к: AZW3, EPUB, MOBI форматам вывода

Задать правила, используемые для исключения книг из сгенерированного каталога. Модель для правила исключения: ('<rule name>','Tags','<comma-separated list of tags>') или ('<rule name>','<custom column>','<pattern>'). Например: (('Archived books','#status','Archived'),) исключит книгу со значением 'Archived' в польз. столбце 'status'. Когда определено несколько правил, все они применятся. По умолчанию: '(('Catalogs','Tags','Catalog'),)' Применяется к: AZW3, EPUB, MOBI форматам вывода

Включить раздел «Авторы» в каталог. По умолчанию: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода

Включить раздел «Примечания» в каталог. По умолчанию: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода

Включить раздел «Жанры» в каталог. По умолчанию: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода

Включить раздел «Недавно добавленные» в каталог. По умолчанию: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода

Включить раздел «Серии» в каталог. По умолчанию: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода

Включить раздел «Названия» в каталог. По умолчанию: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода

Исходное поле для секции 'Жанры'. Умолчание: 'Теги' Применяется к: AZW3, EPUB, MOBI форматам вывода

Пользовательское поле, содержащее текст примечания для вставки в заголовок описания. Умолчание: '' Применяется к: AZW3, EPUB, MOBI форматам вывода

#<custom field>: [before|after]:[True|False] с указанием: <custom field> Пользовательское поле, содержащее примечания для объединения с комментариями [before|after] Размещение примечаний относительно комментариев [True|False] - между примечаниями и комментариями вставляется горизонтальная линия. По умолчанию: '::' Применимо к выходным форматам AZW3, EPUB, MOBI

Определить профиль вывода. В некоторых случаях для оптимизации каталога для устройства требуется профиль вывода. Например 'kindle' or 'kindle_dx' создаст структурированное Оглавление с Разделами и Авторами. Умолчание: 'None' Применяется к: AZW3, EPUB, MOBI форматам вывода

--prefix-rules
Задать правила включения префиксов, указывающих чтение книг, элементы списка пожеланий и др. польз-х префиксов. Модель для префиксного правила ('<rule name>','<source field>','<pattern>','<prefix>'). Когда определено несколько правил, будет использоваться первое правило сопоставления. Умолчание: '(('Read books','tags','+','✓'),('Wishlist item','tags','Wishlist','×'))' Применяется к: AZW3, EPUB, MOBI форматам вывода

Использовать именованный пресет, созданный в GUI конструкторе каталогов Пресет задает все настройки для создания каталога. Умолчание: 'None' Применяется к: AZW3, EPUB, MOBI форматам вывода

Размер подсказки (в дюймах) для обложки книг в каталоге. Диапазон: 1.0 - 2.0 Умолчание: '1.0' Применяется к: AZW3, EPUB, MOBI форматам вывода

Заменить существующую обложку при генерации каталога. Умолчание: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода

SAVED_SEARCHES

calibredb saved_searches [options] (list|add|remove)


Управление сохраненными в этой базе данных поисками. При добавлении запроса с уже существующим именем, он будет заменён.

Синтаксис для добавления:

calibredb saved_searches add search_name search_expression

Синтаксис для удаления:

calibredb saved_searches remove search_name

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

ADD_CUSTOM_COLUMN

calibredb add_custom_column [опции] ярлык имя тип_данных


Создаёт пользовательский столбец, где «ярлык» — удобное для компьютера название столбца, без пробелов и двоеточий; «имя» — удобное для человека название столбца; «тип_данных» один из: bool, comments, composite, datetime, enumeration, float, int, rating, series, text

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Словарь настроек для указания того, как данные в столбцах будут интерпретированы. Это JSON строка. Для перечисления столбцов используйте --display"{\ "enum_values\ ":[\ "val1\ ", \ "val2\ "]}" Есть много настроек, которые можно использовать в переменной отображения. Эти настройки по типу столбца бывают: составными: composite_template, composite_sort, make_category,contains_html, use_decorations даты и времени: date_format перечисление: enum_values, enum_colors, use_decorations целочисленные или с плавающей точкой: number_format текстовые: is_names, use_decorations Для поиска правильных сочетаний лучше всего создать пользовательский столбец соответствующего типа в GUI и посмотреть резервный OPF книги (убедитесь что новый OPF был создан после добавления столбца). Вы увидите JSON для "отображения" для нового столбца в OPF.

Этот столбец хранит теги как данные (например, несколько значений, разделенных запятыми). Применяется только, если тип данных текст.

CUSTOM_COLUMNS

calibredb custom_columns [options]


Список доступных пользовательских столбцов. Показ меток столбцов и идентификаторы.

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Показать подробности для каждой колонки.

REMOVE_CUSTOM_COLUMN

calibredb remove_custom_column [options] labelУдалить пользовательский столбец, идентифицированный меткой. Вы можете увидеть доступные столбцы с командой custom_columns.


Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Не запрашивать подтверждение

SET_CUSTOM

calibredb set_custom [options] column id value


Задать значение настраиваемого столбца для книги определяемой по id. Cписок идентификаторов получается командой поиска. Список пользовательских имен столбцов получается командой custom_columns

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Если столбец содержит несколько значений, добавить указанное значение к существующим, а не заменять их.

RESTORE_DATABASE

calibredb restore_database [настройки]


Восстанавить текущую базу данных из метаданных хранящихся в OPF файлах в каждой папке библиотеки. Это полезно если был повреждён файл metadata.db.

ВНИМАНИЕ: Эта команда полностью пересоздаёт вашу базу данных. Вы потеряете все сохранённые поиски, пользовательские категории, коммутации метаданных, настройки конвертации каждой книги, и пользовательские рецепты. Восстановленные метаданные будут полностью зависеть от того, что будет найдено в файлах OPF.

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Действительно выполнить восстановление. Команда не запустится пока эта опция не определена.

CHECK_LIBRARY

calibredb check_library [настройки]


Выполняет некоторые проверки файловой системы представляющей библиотеку. Отчёты invalid_titles, extra_titles, invalid_authors, extra_authors, missing_formats, extra_formats, extra_files, missing_covers, extra_covers, failed_folders

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Вывод в CSV

Разделённый запятыми список игнорируемых расширений. По умолчанию: все (all).

Разделённый запятыми список игнорируемых названий. По умолчанию: все (all).

Разделённый запятыми список отчётов. По умолчанию: все (all).

LIST_CATEGORIES

calibredb list_categories [настройки]


Генерирует отчёт по категориям в базе данных. Информация соответствует той, что отображается в Браузере тегов.

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Разделённый запятыми список имён поиска категорий. По умолчанию: all

Вывод в CSV

Тип файла CSV для создания. Варианты: excel, excel-tab, unix

Выводить только общее число записей в категории вместо поэлементного подсчёта.

Максимальная ширина строки вывода. По умолчанию - размер экрана.

BACKUP_METADATA

calibredb backup_metadata [опции]


Резервное копирование метаданных, хранящихся в базе данных, в отдельные OPF файлы в каждой директории книг. Обычно это происходит автоматически, но вы можете запустить команду для принудительного пересоздания OPF файлов с опцией --all.

Помните, что обычно в этом нет необходимости, так как OPF файлы резервируются автоматически при каждом изменении метаданных.

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Обычно команда работает только с книгами, имеющими устаревшие OPF файлы. Эта опция заставляет её работать со всеми книгами.

CLONE

calibredb clone path/to/new/library


Создать клон текущей библиотеки. Создаётся новая пустая библиотека, содержащая все пользовательские столбцы, виртуальные библиотеки и прочие параметры, аналогично текущей библиотеке.

Клонированная библиотека не содержит книг. Чтобы создать полную копию со всеми книгами просто скопируйте папку библиотеки.

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

EMBED_METADATA

calibredb embed_metadata [параметры] book_id


Обновление метаданных в файлах текущей книги, хранящейся в библиотеке calibre, из метаданных в базе данных calibre. Обычно метаданные обновляются только во время экспорта файлов из calibre, эта команда полезна, если вы хотите, чтобы файлы были обновлены на месте. Заметьте, что различные форматы файлов поддерживают разное количество метаданных. Вы можете использовать специальное значение 'all' для book_id, чтобы обновить метаданные во всех книгах. Вы можете также задать несколько идентификаторов книг, разделённых пробелами, и диапазон идентификаторов, разделённых дефисами. Например: calibredb embed_metadata 1 2 10-15 23

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Обновлять только метаданные в файлах заданного формата. Задайте несколько раз для нескольких форматов. По умолчанию, обновляются все форматы.

SEARCH

calibredb search [опции] поисковое выражение


Искать в библиотеке указанный поисковый запрос, возвращая разделенный запятыми список идентификаторов книг, соответствующих поисковому запросу. Формат вывода полезен для подачи в другие команды, которые принимают список идентификаторов в качестве входных данных.

Выражение поиска может быть любым из языка поисковых запросов calibre, например: calibredb search author:asimov 'title:"i robot"'

Когда вы передаёте аргументы с пробелами в calibredb, заключайте их в кавычки. Например: "/some path/with spaces"

Максимальное число возвращаемых результатов. По умолчанию - все результаты.

AUTHOR

Kovid Goyal

COPYRIGHT

Kovid Goyal

февраля 26, 2021 5.12.0