CALIBREDB(1) calibre CALIBREDB(1)

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

--help, -h
показать это сообщение и выйти
--library-path, --with-library
Путь к библиотеке 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.
--password
Пароль для подключения к контент-серверу calibre. Чтобы прочитать пароль со стандартного ввода, используйте специальное значение: <stdin>. Чтобы прочитать пароль из файла, используйте: <f:/path/to/file> (т.е. <f: за ним следует полный путь к файлу и закрывающий >). Требуются угловые скобки в приведённом выше разделе, не забудьте экранировать их или использовать кавычки в вашем шелле.
--timeout
Тайм-аут в секундах при подключении к библиотеке calibre по сети. По умолчанию - две минуты.
--username
Имя пользователя для соединения с контент-сервером calibre
--version
показать версию программы и выйти

calibredb список [options]

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

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

--ascending
Сортировать результаты по возрастанию
--fields, -f
Поля, отображаемые при перечислении книг в базе данных. Должен быть разделённый запятыми список полей. Доступные поля: 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
--for-machine
Генерирует вывод в формате JSON, более подходящем для машинного разбора. Игнорирует настройки ширины строки и разделителя.
--limit
Максимальное число результатов для отображения. По умолчанию: все
--line-width, -w
Максимальная ширина строки вывода. По умолчанию - размер экрана.
--prefix
Префикс для всех путей. По умолчанию - абсолютный путь к директории библиотеки.
--search, -s
Фильтровать результаты запроса. С форматом запроса можно ознакомиться в соответствующей документации в руководстве пользователя. По умолчанию не фильтровать.
--separator
Разделитель полей. По умолчанию - пробел.
--sort-by
Поле, по которому сортировать результат. Доступные поля: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, timestamp, title, uuid По умолчанию: id

calibredb добавить [параметры] файл1 файл2 файл3 ...

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

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

--authors, -a
Указать авторов добавляемых книг
--automerge, -m
Если будут найдены книги с похожими названиями и авторами, автоматически объединить входящие форматы (файлы) с существующими книжными записями. Значение "ignore" - повторяющиеся форматы отбрасываются. Значение "overwrite" - повторяющиеся форматы в библиотеке перезаписываются вновь добавленными файлами. Значение "new_record" - повторяющиеся форматы помещаются в новую запись книги.
--cover, -c
Путь к обложке для использования в добавленной книге
--duplicates, -d
Добавлять книги в базу данных, даже если они уже есть. Сравнение - по названиям книг и авторам. Параметр --automerge имеет приоритет.
--empty, -e
Добавить пустую книгу (книгу без форматов)
--identifier, -I
Установить идентификаторы книги, например -I asin:XXX -I isbn:YYY
--isbn, -i
Указать ISBN добавляемых книг
--languages, -l
Список языков через запятую (желательно использовать языкововую кодировку ISO639, хотя могут быть распознаны и некоторые обычные названия языков)
--series, -s
Указать серию добавляемых книг
--series-index, -S
Указать номер в серии у добавляемых книг
--tags, -T
Указать теги добавляемых книг
--title, -t
Установить название добавляемой книги (книг)

Опции для управления добавлением книг из директорий. По умолчанию добавляются только файлы с расширениями известных форматов электронных книг.
--add
Шаблон имени файла (glob), файлы, соответствующие этому шаблону, будут добавлены при сканировании папок на наличие файлов, даже если они не относятся к известному типу файлов электронных книг. Можно указать несколько раз для нескольких шаблонов.
--ignore
Шаблон имени файла (glob), файлы, соответствующие этому шаблону, будут игнорироваться при сканировании папок на наличие файлов. Можно указать несколько раз для нескольких шаблонов. Например: *.pdf игнорирует все файлы PDF
--one-book-per-directory, -1
Предположим, что в каждой папке есть только одна логическая книга и что все файлы в ней представляют собой электронные книги разных форматов этой книги.
--recurse, -r
Рекурсивно обрабатывать папки

calibredb remove ids

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

--all
Экспортировать все книги в базу данных, игнорируя список id.
--dont-asciiize
calibre преобразует все неанглийские символы в английские эквиваленты имен файлов. Это полезно при сохранении в устаревшую файловую систему без полной поддержки имен файлов Unicode. Указание этого переключателя отключит данный режим.
--dont-save-cover
Обычно, calibre будет сохранять обложку в отдельном файле рядом с файлами электронной книги. Указание этого переключателя отключит данный режим.
--dont-update-metadata
По умолчанию calibre обновляет метаданные в сохранённых файлах в библиотеке. Может замедлить запись на диск. Указание этого переключателя отключит данный режим.
--dont-write-opf
Обычно, calibre будет писать метаданные в отдельный файл OPF рядом с файлом электронной книги. Указание этого переключателя отключит данный режим.
--formats
Список форматов, разделенных запятыми, для сохранения для каждой книги. По умолчанию все доступные форматы сохраняются.
--progress
Прогресс отчёта
--replace-whitespace
Заменить пробел символом подчёркивания.
--single-dir
Экспорт всех книг в одну папку
--template
Шаблон для управления именем файла и структурой папок сохраненных файлов. По умолчанию это "{author_sort}/{title}/{title} - {authors}", при котором книги будут сохраняться в подпапку для каждого автора с именами файлов, содержащими название и автора. Доступные элементы управления: {author_sort, authors, id, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, tags, timestamp, title}
--timefmt
Формат отображения дат. %d - день, %b - месяц, %m - номер месяца, %Y - год. По умолчанию: %b, %Y
--to-dir
Экспорт книг в указанную папку. По умолчанию .
--to-lowercase
Преобразовать пути в нижний регистр.

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"

--ids, -i
Разделённый запятыми список идентификаторов из базы данных для каталога. Если указано, --search игнорируется. По умолчанию: all
--search, -s
Фильтровать результаты по поисковому запросу. О формате поискового запроса читайте в связанной с поиском документации в руководстве пользователя. По умолчанию: no filtering (не фильтровать)
--verbose, -v
Показать детальную информацию. Используется для отладки.

--catalog-title
Название сгенерированного каталога, используемого как название в метаданных. По умолчанию: 'My Books' Применяется к: AZW3, EPUB, MOBI форматам вывода
--cross-reference-authors
Создание перекрестных ссылок в разделе «Авторы» для книг с несколькими авторами. По умолчанию: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода
--debug-pipeline
Сохранить вывод из разных этапов конвейера преобразования в указанную папку. Полезно, если вы не уверены, на каком этапе процесса преобразования возникает ошибка. По умолчанию: 'None' Применимо к: выходным форматам AZW3, EPUB, MOBI
--exclude-genre
Regex, описывающий теги для исключения в качестве жанров. По умолчанию: '[.+]|^+$' исключает теги в квадратных скобках, напр. '[Project Gutenberg]', и '+', умолчальный тег для чтения книг. Применяется к: AZW3, EPUB, MOBI форматам вывода
--exclusion-rules
Задать правила, используемые для исключения книг из сгенерированного каталога. Модель для правила исключения: ('<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 форматам вывода
--generate-authors
Включить раздел «Авторы» в каталог. По умолчанию: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода
--generate-descriptions
Включить раздел «Примечания» в каталог. По умолчанию: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода
--generate-genres
Включить раздел «Жанры» в каталог. По умолчанию: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода
--generate-recently-added
Включить раздел «Недавно добавленные» в каталог. По умолчанию: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода
--generate-series
Включить раздел «Серии» в каталог. По умолчанию: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода
--generate-titles
Включить раздел «Названия» в каталог. По умолчанию: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода
--genre-source-field
Исходное поле для секции 'Жанры'. Умолчание: 'Теги' Применяется к: AZW3, EPUB, MOBI форматам вывода
--header-note-source-field
Пользовательское поле, содержащее текст примечания для вставки в заголовок описания. Умолчание: '' Применяется к: AZW3, EPUB, MOBI форматам вывода
--merge-comments-rule
#<custom field>: [before|after]:[True|False] с указанием: <custom field> Пользовательское поле, содержащее примечания для объединения с комментариями [before|after] Размещение примечаний относительно комментариев [True|False] - между примечаниями и комментариями вставляется горизонтальная линия. По умолчанию: '::' Применимо к выходным форматам AZW3, EPUB, MOBI
--output-profile
Определить профиль вывода. В некоторых случаях для оптимизации каталога для устройства требуется профиль вывода. Например '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 форматам вывода
--preset
Использовать именованный пресет, созданный в GUI конструкторе каталогов Пресет задает все настройки для создания каталога. Умолчание: 'None' Применяется к: AZW3, EPUB, MOBI форматам вывода
--thumb-width
Размер подсказки (в дюймах) для обложки книг в каталоге. Диапазон: 1.0 - 2.0 Умолчание: '1.0' Применяется к: AZW3, EPUB, MOBI форматам вывода
--use-existing-cover
Заменить существующую обложку при генерации каталога. Умолчание: 'False' Применяется к: AZW3, EPUB, MOBI форматам вывода

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"

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

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

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

--display
Словарь настроек для указания того, как данные в столбцах будут интерпретированы. Это 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.
--is-multiple
Этот столбец хранит теги как данные (например, несколько значений, разделенных запятыми). Применяется только, если тип данных текст.

calibredb custom_columns [options]

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

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

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

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

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

--force, -f
Не запрашивать подтверждение

calibredb set_custom [options] column id value

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

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

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

calibredb restore_database [параметры]

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

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

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

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

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, -c
Вывод в CSV
--ignore_extensions, -e
Разделённый запятыми список игнорируемых расширений. По умолчанию: все (all).
--ignore_names, -n
Разделённый запятыми список игнорируемых названий. По умолчанию: все (all).
--report, -r
Разделённый запятыми список отчётов. По умолчанию: все (all).

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

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

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

--categories, -r
Разделённый запятыми список имён поиска категорий. По умолчанию: all
--csv, -c
Вывод в CSV
--dialect
Тип файла CSV для создания. Варианты: excel, excel-tab, unix
--item_count, -i
Выводить только общее число записей в категории вместо поэлементного подсчёта.
--width, -w
Максимальная ширина строки вывода. По умолчанию - размер экрана.

calibredb backup_metadata [параметры]

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

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

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

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

calibredb clone path/to/new/library

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

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

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

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

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

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

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

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

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

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

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

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

Kovid Goyal

Kovid Goyal
апреля 30, 2021 5.17.0