calibredb

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

calibredb is the command line interface to the calibre database. It has several sub-commands, documented below.

calibredb can be used to manipulate either a calibre database specified by path or a calibre Content server running either on the local machine or over the internet. You can start a calibre Content server using either the calibre-server program or in the main calibre program click Connect/share  →  Start Content server. Since calibredb can make changes to your calibre libraries, you must setup authentication on the server first. There are two ways to do that:

  • If you plan to connect only to a server running on the same computer, you can simply use the --enable-local-write option of the content server, to allow any program, including calibredb, running on the local computer to make changes to your calibre data. When running the server from the main calibre program, this option is in Preferences → Sharing over the net → Advanced.
  • If you want to enable access over the internet, then you should setup user accounts on the server and use the --username and --password options to calibredb to give it access. You can setup user authentication for calibre-server by using the --enable-auth option and using --manage-users to create the user accounts. If you are running the server from the main calibre program, use Preferences → Sharing over the net → Require username/password.

To connect to a running Content server, pass the URL of the server to the --with-library option, see the documentation of that option for details and examples.

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

--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: за ним следует полный путь к файлу и закрывающий >). Требуются угловые скобки в приведённом выше разделе, не забудьте экранировать их или использовать кавычки для вашего шелла.

--username

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

--version

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

list

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

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

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

--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

add

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

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

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

--authors, -a

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

--cover, -c

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

--duplicates, -d

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

--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

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

--one-book-per-directory, -1

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

--recurse, -r

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

remove

calibredb remove ids

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

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

--permanent

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

add_format

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

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

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

--dont-replace

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

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»

--as-opf

Напечатать метаданные в 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, -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.

export

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

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

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

--all

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

--dont-asciiize

По умолчанию, в именах файлов calibre конвертирует все не английские символы в английские эквиваленты. ПРЕДУПРЕЖДЕНИЕ: если вы выключите эту опцию, могут появиться ошибки при сохранении, в зависимости от того, насколько хорошо поддерживает юникод файловая система, в которой вы сохраняете. Указание этого переключателя отключит данный режим.

--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

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

catalog

calibredb catalog /путь/к/месту.(csv|epub|mobi|xml...) [опции]

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

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

--ids, -i

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

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

--verbose, -v

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

ОПЦИИ EPUB

--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] specifying: <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 форматам вывода

saved_searches

calibredb saved_searches [options] (list|add|remove) Управление сохраненными поисками, хранящимися в этой базе данных. При добавлении запроса с уже существующим именем, он будет заменён. Синтаксис для добавления: % Prog 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»

--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

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

custom_columns

calibredb custom_columns [options]

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

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

--details, -d

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

remove_custom_column

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

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

--force, -f

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

set_custom

calibredb set_custom [options] column id valueЗадайте значение настраиваемого столбца для книги, идентифицированной идентификатором.Вы можете получить список идентификаторов с помощью команды поиска.Вы можете получить список пользовательских имен столбцов, используя custom_columns

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

--append, -a

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

restore_database

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

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

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

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

--really-do-it, -r

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

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, -c

Вывод в CSV

--ignore_extensions, -e

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

--ignore_names, -n

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

--report, -r

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

list_categories

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

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

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

--categories, -r

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

--csv, -c

Вывод в CSV

--dialect

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

--item_count, -i

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

--width, -w

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

backup_metadata

calibredb backup_metadata [опции]

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

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

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

--all

Обычно команда работает только с книгами, имеющими устаревшие 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»

--only-formats, -f

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