NAME¶

calibredb - calibredb

calibredb comando [options] [arguments]

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:

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.

OPÇÕES GLOBAIS¶

LIST¶

calibredb list [options]

Lista de livros disponíveis na base de dados do Calibre.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

ADD¶

calibredb add [options] ficheiro1 ficheiro2 ficheiro3 ...

Adicionar os ficheiros especificados à base de dados. Também pode especificar pastas: ver abaixo as opções relativas às pastas.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

REMOVE¶

calibredb remover ids

Remover os livros, identificados por ID, da base de dados. Os ID devem estar numa lista de números de ID, separados por vírgulas. Você pode obter o numero de ID através do comando de pesquisa. Por exemplo, 23,34,57-85 (se especificar um intervalo, o último número do intervalo não será incluído).

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

ADD_FORMAT¶

calibredb add_format [options] ID ebook_file

Adicionar o livro em ebook_file para os formatos disponíveis para o livro lógico identificado por ID. Pode obter o ID usando o comando de pesquisa. Caso o formato já exista será substituído, a menos que esteja especificada a opção de não substituir.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

REMOVE_FORMAT¶

calibredb remove_format [options] id fmt

Remover o formato fmt do livro lógico identificado pelo ID. Pode saber o ID usando o comando search. fmt deve ser uma extensão de ficheiro como LRF ou TXT ou EPUB. Se o livro lógico não tem fmt disponível, não fazer nada.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

SHOW_METADATA¶

calibredb show_metadata [options] id

Mostrar os metadados armazenados na base de dados do Calibre para o livro identificado pelo ID. O ID é um número de identificação do comando de pesquisa.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

SET_METADATA¶

calibredb set_metadata [options] book_id [/path/to/metadata.opf]

Definir os metadados armazenados na base de dados Calibre para o livro identificado por book_id do ficheiro OPF metadata.opf. book_id é um número de identificação do comando de pesquisa. Pode ter uma ideia do formato OPF utilizando a opção --as-opf alternando para o comando show_metadata. Também pode definir os metadados de campos individuais com a opção --field. Se usar a opção --field, não é necessário especificar um ficheiro OPF.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

EXPORT¶

calibredb exportar [options] ID

Exporta os livros especificados pelos ID (numa lista separada por virgulas) para o sistema de ficheiros. A operação de exportação guarda todos os formatos do livro, a sua capa e os metadados (estes num ficheiro OPF). Pode obter os números de ID através do comando de pesquisa.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

CATALOG¶

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

Exporta um catálogo em formato especificado por caminho/para/destino.extensão. As opções controlam a forma como as entradas serão mostradas no catálogo de saída gerada. Note que diferentes formatos de catálogo suportam diferentes conjuntos de opções. Para ver as diferentes opções, especifique o nome do ficheiros de saída e depois a opção --help

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

SAVED_SEARCHES¶

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

Manage the saved searches stored in this database. If you try to add a query with a name that already exists, it will be replaced.

Syntax for listing, the default action:

calibredb saved_searches list

Syntax for adding:

calibredb saved_searches add search_name search_expression

Syntax for removing:

calibredb saved_searches remove search_name

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

ADD_CUSTOM_COLUMN¶

calibredb add_custom_column [options] label name datatype

Cria uma coluna personalizada. LABEL é o nome amigável da coluna para a máquina. Não pode conter espaços ou dois pontos. NAME é o nome amigável da coluna para humanos. DATATYPE pode ser um dos seguintes: bool, comments, composite, datetime, enumeration, float, int, rating, series, text

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

CUSTOM_COLUMNS¶

calibredb custom_columns [opções]

Lista as colunas personalizadas disponíveis. Mostra rótulos de colunas e os ID.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

REMOVE_CUSTOM_COLUMN¶

calibredb remove_custom_column [opções] etiquetas

Remover o campo personalizado com o rótulo especificado. Pode ver quais os campos personalizados disponíveis com o comando custom_columns.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

SET_CUSTOM¶

calibredb set_custom [opções] valor ID coluna

Define o conteúdo de um coluna personalizada para o livro identificado pelo ID. Pode obter uma lista dos ID usando o comando search. Pode obter uma lista de colunas personalizadas usando o comando custom_columns.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

RESTORE_DATABASE¶

calibredb restore_database [options]

Restore this database from the metadata stored in OPF files in each folder of the calibre library. This is useful if your metadata.db file has been corrupted.

WARNING: This command completely regenerates your database. You will lose all saved searches, user categories, plugboards, stored per-book conversion settings, and custom recipes. Restored metadata will only be as accurate as what is found in the OPF files.

The exit status is 0 if the restore succeeded, 1 if it failed completely and 2 if the database was restored but some books or other data could not be.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

CHECK_LIBRARY¶

calibredb check_library [options]

Executar algumas verificações no sistema de ficheiros representando uma biblioteca. Os relatórios são invalid_titles, extra_titles, invalid_authors, extra_authors, missing_formats, extra_formats, extra_files, missing_covers, extra_covers, malformed_formats, malformed_paths, failed_folders

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

LIST_CATEGORIES¶

calibredb list_categories [options]

Produz um relatório das informações da categoria na base de dados. A informação é equivalente à que é mostrada no navegador de conteúdos.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

BACKUP_METADATA¶

calibredb backup_metadata [options]

Cópia de segurança dos metadados armazenados na base de dados em ficheiros OPF individuais em cada diretório de livros. Normalmente isto acontece automaticamente, mas pode executar este comando para forçar uma recriação dos ficheiros OPF, com a opção --all.

Note que normalmente não há necessidade de fazer isto, pois os ficheiros OPF são copiados automaticamente sempre que os metadados sejam alterados.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

CLONE¶

calibredb clone path/to/new/library

Criar um clone da biblioteca atual. Isto cria uma nova biblioteca, vazia, mas que contém as mesmas colunas personalizadas, bibliotecas virtuais e outras configurações da biblioteca atual.

A biblioteca clonada não contém livros. Se quiser criar uma cópia completa, incluindo todos os livros, use as ferramentas do sistema operativo para copiar a pasta da biblioteca.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

EMBED_METADATA¶

calibredb embed_metadata [opções] book_id

Atualiza os metadados nos ficheiros atuais dos livros existentes na biblioteca do Calibre a partir dos metadados guardados na base de dados do Calibre. Normalmente, os metadados são atualizados apenas quando se exportam ficheiros a partir do Calibre, donde este comando é útil quando pretende que os ficheiros sejam atualizados na pasta onde estão guardados. Note que diferentes formatos de ficheiro suportam diferentes quantidades de metadados. Pode usar o valor especial 'all' para o parâmetro book_id de modo a atualizar os metadados em todos os livros. Pode também especificar múltiplos ID de livros separando-os com espaços ou usando gamas de ID, separados por hífenes. Por exemplo: calibredb embed_metadata 1 2 10-15 23

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

SEARCH¶

calibredb search [opções] expressão_de_pesquisa

Procura nesta biblioteca o termo de pesquisa especificado, devolvendo uma lista de ID de livros, separada por virgulas, que correspondem ao critério de pesquisa. O formato de saída é útil como fonte de dados para outros comandos que aceitem uma lista de ID como valor de entrada.

A expressão de pesquisa pode ser qualquer das possíveis construções da poderosa linguagem de queries de pesquisa do Calibre, como por exemplo: calibredb search author:asimov 'title:"i robot"'

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

FTS_INDEX¶

calibredb fts_index [opções] enable/disable/status/reindex

Controla o processo de indexação da pesquisa no texto completo (PTC).

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

FTS_SEARCH¶

calibredb fts_search [opções] expressão de pesquisa

Executa uma pesquisa de texto integral em toda a biblioteca ou num seu subconjunto.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

NOTES¶

calibredb notes [options] [list|search|show|set|remove]

Manage the notes attached to items such as authors, series, tags and publishers. FIELD is the lookup name of the field, for example: authors, series, tags, publisher or #mycolumn. ITEM is the name of the item, for example the name of an author. Items are matched case insensitively.

List the items that have notes, optionally only those in the specified field. This is the default action:

calibredb notes list [FIELD]

Search the text of notes using the same SQLite full text search syntax as the Browse notes tool in calibre. Print the field, item name and an excerpt for each match. Use --field to search only the notes in a particular field:

calibredb notes search "search expression" calibredb notes search --field authors "search expression"

Print the note for an item as Markdown formatted text, or with --as-html as an HTML document with any images embedded, suitable for use with set:

calibredb notes show FIELD ITEM

Replace the note for an item with the contents of an HTML file. Use - to read the HTML from standard input. Images embedded as base64-encoded data: URLs are added to the note for both local and remote libraries. When using a local library and reading from a file, images referenced by paths relative to the file are added as well:

calibredb notes set FIELD ITEM FILE

Remove the note for an item:

calibredb notes remove FIELD ITEM

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

ITEMS¶

calibredb items [options] (rename|remove) FIELD ITEM ...

Rename or remove items such as authors, tags, series and publishers in all books, the same as the Manage authors, tags, etc. actions in the calibre interface. FIELD is the lookup name of the field, for example: authors, tags, series, publisher or #mycolumn. Items are matched case insensitively.

Rename an item. If an item named NEW_NAME already exists, the two items are merged. For fields that contain multiple values, NEW_NAME can contain more than one value, separated by the separator for the field, for example a comma for tags. The item is then replaced by all the values:

calibredb items rename FIELD ITEM NEW_NAME

Remove one or more items from all books. Authors cannot be removed:

calibredb items remove FIELD ITEM [ITEM ...]

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

VIRTUAL_LIBRARIES¶

calibredb virtual_libraries [options] [list|add|rename|remove]

Manage the Virtual libraries of this library. A Virtual library is a search that behaves as though the library contains only the books it matches. To list or search the books in a Virtual library, use: calibredb search 'vl:"name"'

List the Virtual libraries, with their searches and number of books. This is the default action:

calibredb virtual_libraries list

Create a Virtual library from a search:

calibredb virtual_libraries add name search_expression

Rename a Virtual library:

calibredb virtual_libraries rename name new_name

Remove Virtual libraries, the books in them are not changed:

calibredb virtual_libraries remove name ...

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

ANNOTATIONS¶

calibredb annotations [options] [list|search|export|import|remove]

Manage the annotations, that is the highlights and bookmarks, of books, as created in the calibre E-book viewer or synced from other applications.

List the annotations, with their ids. This is the default action:

calibredb annotations list

Search highlighted text, annotation notes and bookmark titles using the same SQLite full text search syntax as the Browse annotations tool. Results are ordered by relevance and include annotation ids, book titles and matching excerpts. Use --search to restrict the books, --type to restrict the annotation type, --user-type and --annotation-user to restrict the user, --no-stemming to match exact word forms, or --format json for a JSON array of results including the annotation data and excerpts:

calibredb annotations search "search expression"

Export the annotations as plain text, Markdown or JSON, grouped by book. The JSON is the same calibre annotation collection as created by the Export button in the Browse annotations tool:

calibredb annotations export

Import a calibre annotation collection exported as JSON by this command or the Browse annotations tool. The collection must contain annotations from only one book. BOOK_ID is the destination book id, not the id stored in the file. Only the annotations of the format FORMAT are imported, annotations of other formats are skipped. FORMAT must exist in the destination book. Use the same edition of the book so positions match:

calibredb annotations import BOOK_ID FORMAT FILE

Use - for FILE to read from standard input. The entire collection is validated before importing. Annotations are merged with existing ones using the viewer's rules: highlights are matched by UUID and bookmarks by title, and the newer timestamp wins. Repeated imports do not create duplicates. Unrelated annotations and reading positions are preserved.

By default annotations are imported into those of the calibre E-book viewer. Use --user-type web --annotation-user USER to import them into those of a Content server user instead. Exported collections record the user the annotations belong to, and if a collection contains annotations of more than one user, it is rejected. Use the --user-type and --annotation-user options when exporting, to export the annotations of a single user.

Permanently remove the annotations with the specified ids, as shown by list:

calibredb annotations remove ID ...

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

TRASH¶

calibredb trash [options] (list|restore|delete|empty) [ids]

Manage the books and formats that have been removed and placed in the trash bin. Entries in the trash bin are permanently deleted automatically after some days. ids is a comma separated list of book ids, as for the remove command, for example: 23,34,57-85 (when specifying a range, the last number in the range is not included).

List the removed books and formats, most recently removed first, with the times they were removed in local time. Removed formats of books that no longer exist are marked as not restorable, they can only be deleted. With --for-machine, the times are in UTC:

calibredb trash list

Restore removed books, or with --formats, the removed formats of books:

calibredb trash restore ids

Permanently delete entries from the trash bin:

calibredb trash delete ids

Permanently delete everything in the trash bin:

calibredb trash empty

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

DATA_FILES¶

calibredb data_files [options] (list|add|get|rename|remove) BOOK_ID ...

Manage the extra data files associated with a book, in local or remote libraries. Names are relative to the book's data directory. Use / for subdirectories, is also accepted. Files whose names contain a are listed, but cannot otherwise be managed. E-book formats, covers and metadata.opf cannot be accessed with this command. Remote libraries require an account with write access, as for other management commands, and do not support accounts with per-library search restrictions.

List file names, sizes in bytes and modification times (seconds since the Unix epoch). Use --for-machine for JSON output:

calibredb data_files list BOOK_ID

Add a file, using its basename, or --name to specify a name or subdirectory. Existing files are not replaced unless --replace is specified. This is also available through add_format --as-extra-data-file:

calibredb data_files add BOOK_ID FILE

Save one data file to --output on the local machine. Existing output files are not replaced unless --replace is specified:

calibredb data_files get BOOK_ID NAME --output FILE

Rename a file. Existing destinations are not replaced unless --replace is set:

calibredb data_files rename BOOK_ID NAME NEW_NAME

Remove a file to the operating system's recycle bin. With --permanent, delete it permanently instead. For remote libraries this happens on the server:

calibredb data_files remove BOOK_ID NAME

Directories left empty by rename and remove are deleted. With remote libraries, each file is transferred in a single request, so very large files need enough memory on both the client and the server, and uploads are limited by the maximum request size of the server.

Sempre que passar argumentos para o calibredb que contenham espaços ponha-os entre aspas. Por exemplo: "/some path/with spaces"

Author¶

Kovid Goyal

Copyright¶

Kovid Goyal