CALIBREDB(1)

NAME
calibredb - calibredb

calibredb command [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:

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

•   OPÇÕES GLOBAIS

•   list

•   add

•   ADICIONAR A PARTIR DE DIRETÓRIOS

•   remove

•   add_format

•   remove_format

•   show_metadata

•   set_metadata

•   export

•   catalog

•   EPUB OPÇÕES

•   saved_searches

•   add_custom_column

•   custom_columns

•   remove_custom_column

•   set_custom

•   restore_database

•   check_library

•   list_categories

•   backup_metadata

•   clone

•   embed_metadata

•   search

OPÇÕES GLOBAIS

--help, -h
    mostrar esta mensagem de ajuda e sair

--library-path, --with-library
    Path to the calibre library. Default is to use the path stored in the settings. You can also connect to a calibre Content server to perform actions on remote libraries. To do so use a URL of the form: http://hostname:port/#library_id for example, http://localhost:8080/#mylibrary. library_id is the library id of the library you want to connect to on the Content server. You can use the special library_id value of - to get a list of library ids available on the server. For details on how to setup access via a Content server, see https://manual.calibre-ebook.com/generated/en/calibredb.html.

--password
    Password for connecting to a calibre Content server. To read the password from standard input, use the special value: <stdin>. To read the password from a file, use: <f:/path/to/file> (i.e. <f: followed by the full path to the file and a trailing >). The angle brackets in the above are required, remember to escape them or use quotes for your shell.

--username
    Nome de usuário para conectar ao servidor de conteúdo do Calibre

--version
    mostrar número da versão do programa e sair

LIST

calibredb list [opções]

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--ascending
    Ordenar resultados em ordem ascendente

--fields, -f
    Campos que serão exibidos ao listar livros no banco de dados. Deve ser uma lista de campos separada por vírgulas. Campos disponíveis: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, timestamp, title, uuid Padrão: title,authors. O campo especial "all" pode ser usado para selecionar todos os campos. Em complemento aos campos acima, campos personalizados também estão disponíveis como *field_name. Por exemplo, para um campo personalizado #rating, use o nome: *rating.

--for-machine
    Gerar saída no modo JSON, o que é mais adequado para a análise automática. Faz com que a largura de linha e opções de separação sejam ignoradas.

--limit
    O número máximo de resultados para exibir. Padrão: tudo

--line-width, -w
    A largura máxima de uma única linha na saída. O padrão é detectar o tamanho da tela.

--prefix
    O prefixo do caminho de todos arquivos. O padrão é o caminho completo até a pasta da biblioteca.

--search, -s
    Filtrar os resultados pela frase de pesquisa. Para o formato da frase de pesquisa, consulte a documentação à respeito de pesquisa no Manual do Usuário. O padrão é não filtrar.

--separator
    O Caractere usado para separar os campos. O padrão é um espaço.

--sort-by
    O campo pelo qual ordenar os resultados. Campos disponíveis: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, timestamp, title, uuid Padrão: id

ADD

calibredb add [opções] arquivos1 arquivo2 arquivo3 ...

Adicionar os arquivos especificados como livros para a base de dados. Você pode também especificar diretórios, consulte abaixo as opções relacionadas com diretórios.

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--authors, -a
    Configure o(s) autor(es) do(s) livro(s) adicionado(s)

--cover, -c
    Caminho para a capa para usar no livro adicionado

--duplicates, -d
    Adicionar livros para a base de dados mesmo se eles já existirem. Comparação é feita baseada nos títulos dos livros.

--empty, -e
    Adicionar um livro vazio (um livro sem formatos)

--identifier, -I
    Defina identificadores para esse livro, como: -I asin:XXX -I isbn:YYY

--isbn, -i
    Configure o ISBN do(s) livro(s) adicionado(s)

--languages, -l
    Uma lista de idiomas separados por vírgulas (melhor usar códigos de idioma ISO639, assim alguns nomes de idiomas possam também ser reconhecidos)

--series, -s
    Configure as séries do(s) livro(s) adicionado(s)

--series-index, -S
    Configure o número de série do(s) livro(s) adicionado(s)

--tags, -T
    Configure as etiquetas do(s) livro(s) adicionado(s)

--title, -t
    Configure o título do(s) livro(s) adicionado(s)

  ADICIONAR A PARTIR DE DIRETÓRIOS

Opções para controlar a adição de livros a partir de diretórios. Por padrão, apenas os arquivos que tem uma extensão de e-book conhecida são adicionados.

--add
    Um padrão de nome de arquivo (glob), arquivos que correspondam a este padrão serão adicionados ao varrer diretórios por arquivos, mesmo se forem de um tipo de e-book desconhecido. Pode ser especificado múltiplas vezes para múltiplos padrões.

--ignore
    Um padrão (glob) de nome de arquivo. Arquivos correspondentes a este padrão serão ignorados ao varrer diretórios por arquivos. Pode ser especificado múltiplas vezes para múltiplos padrões. Por exemplo: *.pdf irá ignorar todos os arquivos pdf

--one-book-per-directory, -1
    Assumir que cada diretório possui apenas um eBook e que todos os arquivos de um diretório sejam formatos diferentes de um mesmo eBook

--recurse, -r
    Processar diretórios recursivamente

REMOVE

calibredb remove ids

Remove os livros identificados por IDs do banco de dados. IDs devem ser uma lista de números id separados por vírgulas (você pode pegar os números de ids utilizando o comando de busca). Por exemplo, 23 ,34,57-85 (quando especificar um alcance, o último número não é incluído).

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--permanent
    Não usar o lixo

ADD_FORMAT

calibredb add_format [options] id ebook_file

Adiciona o livro em ebook_file para os formatos disponíveis de livro lógico identificados por id. Você pode pegar um id usando o comando de busca. Se o formato já existe, ele é substituído, a menos que a opção de não substituir seja marcada.

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--dont-replace
    Não substituir o formato se ele já existir

REMOVE_FORMAT

calibredb remove_format [options] id fmt

remove o formato fmt de um livro lógico identificado pelo id. Você pode pegar o id utilizando o comando de busca. fmt pode ser uma extensão de arquivo como LRF ou TXT ou EPUB. Se o arquivo lógica não tem fmt disponível, não faz nada.

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

SHOW_METADATA

calibredb show_metada[options] id

Apresenta os metadados armazenados na base de dados do calibre para o livro identificado pelo id. Id é um número de id do comando de busca.

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--as-opf
    Imprimir metadados num formulário OPF (XML)

SET_METADATA

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

Seta o metadado armazenado na base de dados do calibre para o livro identificado pelo id para o arquivo OPF metadata.opf. Id é um número de id do comando de busca. Você pode pegar rapidamente para o formato OPF utilizando --as-opf no comando show_metadata. Você pode também setar o metadado de campos individuais com a opção --field. Se você utilizar a opção --field, não é necessário especificar um arquivo OPF.

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--field, -f
    O campo a ser definido. O formato é field_name:value, por exemplo: --field tags:tag1,tag2. Use --list-fields para obter uma lista de todos os nomes de campo. Você pode especificar essa opção várias vezes para definir vários campos. Nota: Para idiomas que você deve usar os códigos de linguagem ISO639 (por exemplo, en para Inglês, fr para Francês e assim por diante). Para identificadores, a sintaxe é --field identifiers:isbn:XXXX,doi:YYYYY. Para campos booleanos (sim/não) usam verdadeiro e falso ou sim e não.

--list-fields, -l
    Listar os nomes dos campos de metadados que podem ser usados ​​com a opção --field

EXPORT

calibredb export [options] ids

Exportar os livros especificados pelos id (uma lista separada por vírgula) para o sistema de arquivos. A operação de exportação save todos os formatos do livro, suas capas e metadados(em um arquivo opf). Você pode pegar os números de id do comando de busca.

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--all
    Exportar todos os livros do banco de dados, ignorando a lista de IDs.

--dont-asciiize
    Normalmente, o calibre irá converter todos caracteres não Ingleses em equivalentes Ingleses para os nomes dos arquivos. AVISO: Se você desligar este, você poderá experimentar erros durante salvamentos, dependendo de como o sistema de arquivos que você está salvando suporta "unicode". Especificar esta mudança desligará este comportamento

--dont-save-cover
    Normalmente, o calibre irá salvar a capa em um arquivo separado juntamente com os atuais arquivos do e-book Especificar esta mudança desligará este comportamento

--dont-update-metadata
    Normalmente, o calibre atualizará os metadados nos arquivos salvos que estejam na biblioteca do calibre. Faz com que salvamentos no disco sejam mais lentos. Especificar esta mudança desligará este comportamento

--dont-write-opf
    Normalmente, calibre escreverá os metadados dentro de arquivos OPF separados com os arquivos de e-book atuais. Especificar esta mudança desligará este comportamento

--formats
    Lista separada por vírgulas de formatos para salvar cada livro. Por padrão todos formatos disponíveis são salvos.

--progress
    Relatar progresso

--replace-whitespace
    Substituir espaços em branco por "_".

--single-dir
    Exportar todos os livros em um diretório

--template
    Modelo para controlar a estrutura de nome do arquivo e diretório dos arquivos salvos. O padrão é "{author_sort}/{title}/{title} - {authors}", que vai salvar os livros em um subdiretório por autor com nomes de arquivos contendo título e autor. Os controles disponíveis são: {author_sort, authors, id, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, tags, timestamp, title}

--timefmt
    O formato para exibir datas. %d - dia, %b - mês, %m - número do mês, %Y - ano. O padrão é: %b, %Y

--to-dir
    Exportar livros para o diretório especificado. O padrão é .

--to-lowercase
    Converter caminhos para letras minúsculas

CATALOG

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

Exporta um catálogo em formato especificado pela extensão path/to/destination. Opções controlam como as entradas são exibidas no catálogo gerado. Note que formatos de catálogos diferentes suportam diferentes conjuntos de opções.

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--ids, -i
    Lista separada por vírgulas dos IDs da base de dados do catálogo. Se declarado, --search será ignorado. Padrão: todos

--search, -s
    Filtre os resultados por uma frase de pesquisa. Para o formato da frase de pesquisa, consulte a documentação relacionada a pesquisa no Manual do Usuário. Padrão: sem filtros

--verbose, -v
    Mostrar informação detalhada de saída. Útil para depuração

  EPUB OPÇÕES

--catalog-title
    Title of generated catalog used as title in metadata. Default: 'My Books' Applies to: AZW3, EPUB, MOBI output formats

--cross-reference-authors
    Create cross-references in Authors section for books with multiple authors. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

--debug-pipeline
    Save the output from different stages of the conversion pipeline to the specified directory. Useful if you are unsure at which stage of the conversion process a bug is occurring. Default: 'None' Applies to: AZW3, EPUB, MOBI output formats

--exclude-genre
    Regex describing tags to exclude as genres. Default: '[.+]|^+$' excludes bracketed tags, e.g. '[Project Gutenberg]', and '+', the default tag for read books. Applies to: AZW3, EPUB, MOBI output formats

--exclusion-rules
    Specifies the rules used to exclude books from the generated catalog. The model for an exclusion rule is either ('<rule name>','Tags','<comma-separated list of tags>') or ('<rule name>','<custom column>','<pattern>'). For example: (('Archived books','#status','Archived'),) will exclude a book with a value of 'Archived' in the custom column 'status'. When multiple rules are defined, all rules will be applied. Default: "(('Catalogs','Tags','Catalog'),)" Applies to: AZW3, EPUB, MOBI output formats

--generate-authors
    Include 'Authors' section in catalog. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

--generate-descriptions
    Include 'Descriptions' section in catalog. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

--generate-genres
    Include 'Genres' section in catalog. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

--generate-recently-added
    Include 'Recently Added' section in catalog. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

--generate-series
    Include 'Series' section in catalog. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

--generate-titles
    Include 'Titles' section in catalog. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

--genre-source-field
    Source field for 'Genres' section. Default: 'Etiquetas' Applies to: AZW3, EPUB, MOBI output formats

--header-note-source-field
    Custom field containing note text to insert in Description header. Default: '' Applies to: AZW3, EPUB, MOBI output formats

--merge-comments-rule
    #<custom field>:[before|after]:[True|False] specifying: <custom field> Custom field containing notes to merge with Comments [before|after] Placement of notes with respect to Comments [True|False] - A horizontal rule is inserted between notes and Comments Default: '::' Applies to: AZW3, EPUB, MOBI output formats

--output-profile
    Specifies the output profile. In some cases, an output profile is required to optimize the catalog for the device. For example, 'kindle' or 'kindle_dx' creates a structured Table of Contents with Sections and Articles. Default: 'None' Applies to: AZW3, EPUB, MOBI output formats

--prefix-rules
    Specifies the rules used to include prefixes indicating read books, wishlist items and other user-specified prefixes. The model for a prefix rule is ('<rule name>','<source field>','<pattern>','<prefix>'). When multiple rules are defined, the first matching rule will be used. Default: "(('Read books','tags','+','✓'),('Wishlist item','tags','Wishlist','×'))" Applies to: AZW3, EPUB, MOBI output formats

--preset
    Use a named preset created with the GUI catalog builder. A preset specifies all settings for building a catalog. Default: 'None' Applies to: AZW3, EPUB, MOBI output formats

--thumb-width
    Size hint (in inches) for book covers in catalog. Range: 1.0 - 2.0 Default: '1.0' Applies to: AZW3, EPUB, MOBI output formats

--use-existing-cover
    Replace existing cover when generating the catalog. Default: 'False' Applies to: AZW3, EPUB, MOBI output formats

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

calibredb saved_searches add search_name search_expression

Syntax for removing:

calibredb saved_searches remove search_name

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

ADD_CUSTOM_COLUMN

calibredb add_custom_column [opções] identificador nome tipo-de-dado

Criar uma coluna personalizada. "identificador" é o nome de máquina para coluna. Não pode conter espaços ou dois-pontos. "nome" é o nome da coluna que será exibido. tipo-de-dado pode ser um dos seguintes: bool, comments, composite, datetime, enumeration, float, int, rating, series, text

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--display
    Um dicionário de opções para personalizar a forma como os dados nesta coluna serão interpretados. Esta é uma string JSON. Para colunas de enumeração, use --display"{\ "enum_values\ ":[\ "val1\ ", \ "val2\ "]}" Existem muitas opções que podem ir para as opções de variáveis de exibição. As opções por tipo de coluna são: composite: composite_template, composite_sort, make_category,contains_html, use_decorations datetime: date_format enumeration: enum_values, enum_colors, use_decorations int, float: number_format text: is_names, use_decorations A melhor maneira de encontrar combinações legais é criar uma coluna personalizada do tipo apropriado na GUI e em seguida olhar para o backup OPF de um livro (assegure-se que um novo OPF foi criado da coluna foi acrescentado). Você vai ver o JSON da "exibição" para a nova coluna em OPF.

--is-multiple
    Este campo armazena dados como etiquetas (ex. vários valores separados por vírgulas). Somente se aplica se o tipo de dados for texto.

CUSTOM_COLUMNS

calibredb custom_columns [options]

Lista colunas personalizadas disponíveis. Exibe os nomes dos campos e seus IDs.

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--details, -d
    Mostrar detalhes para cada campo.

REMOVE_CUSTOM_COLUMN

calibredb remove_custom_column [options] label

Remove the custom column identified by label. You can see available columns with the custom_columns command.

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--force, -f
    Não pedir confirmação

SET_CUSTOM

calibredb set_custom [options] column id value

Set the value of a custom column for the book identified by id. You can get a list of ids using the search command. You can get a list of custom column names using the custom_columns command.

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--append, -a
    Se o campo possibilitar armazenar diversos valores, não sobrescreva os valores adicione os valores especificados aos já existentes.

RESTORE_DATABASE

calibredb restore_database [options]

Restaurar esse banco de dados dos metadados armazenados em arquivos OPF em cada diretório de biblioteca do calibre. Isto é útil se o seu arquivo metadata.db foi corrompido.

AVISO: Este comando regenera completamente o seu banco de dados. Você vai perder todas as buscas salvas, as categorias de usuários, quadros de dispositivos, configurações armazenadas por conversão de livros, e receitas personalizadas. Os metadados restaurados serão apenas tão precisos quanto aos encontrados nos arquivos OPF

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--really-do-it, -r
    Realmente faz a recuperação. O comando não será executado, a menos que esta opção seja especificada.

CHECK_LIBRARY

calibredb check_library [options]

Executar algumas verificações no sistema de arquivos 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, failed_folders

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--csv, -c
    Saída em CSV

--ignore_extensions, -e
    Lista de extensões separadas por vírgula para ignorar. Padrão: tudo

--ignore_names, -n
    Lista de nomes separados por vírgula para ignorar. Padrão: tudo

--report, -r
    Lista de relatórios separados por vírgula. Padrão: tudo

LIST_CATEGORIES

calibredb list_categories [options]

Produzir um relatório das informações da categoria no banco de dados. A informação é equivalente a que é mostrada no painel de etiquetas.

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--categories, -r
    Lista de categorias separadas por vírgula para pesquisar nomes. Padrão: tudo

--csv, -c
    Saída em CSV

--dialect
    Tipo de arquivo CSV que será produzido. Escolhas: excel, excel-tab

--item_count, -i
    Processa apenas o número de itens em uma categoria, em vez das contagens por item dentro da categoria

--width, -w
    A largura máxima de uma única linha na saída. O padrão é detectar o tamanho da tela.

BACKUP_METADATA

calibredb backup_metadata [options]

Backup dos metadados armazenados no banco de dados em arquivos OPF individuais em cada diretório de livros. Isso normalmente acontece automaticamente, mas você pode executar este comando para forçar uma nova geração dos arquivos OPF, com a opção --all.

Note que normalmente não há necessidade de fazer isso, pois os arquivos OPF são copiados automaticamente, toda vez que os metadados são alterados.

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--all
    Normalmente, este comando apenas opera em livros que tenham arquivos OPF desatualizados. Esta opção irá criar operações em todos os livros.

CLONE

calibredb clone path/to/new/library

Criar um clone da biblioteca atual. Isto cria uma nova biblioteca vazia que contém as mesmas colunas personalizadas, bibliotecas virtuais e outros ajustes como a biblioteca atual.

A biblioteca clonada não contêm livros. Se você quiser criar uma cópia completa, incluindo todos os livros, use em seguida suas ferramentas de sistema de arquivos para copiar a pasta da biblioteca.

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

EMBED_METADATA

calibredb embed_metadata [options] book_id

Atualizar os metadados nos arquivos de livros atuais armazenados na biblioteca do calibre dos metadados no banco de dados do calibre. Normalmente, os metadados são atualizadas apenas quando exportar arquivos do calibre, este comando é útil se você deseja que os arquivos

sejam atualizados no local. Observe que diferentes formatos de arquivos suportam diferentes
    quantidades de metadados. Você pode usar o valor especial 'all' para book_id para atualizar os metadados em todos os livros. Você também pode especificar várias ids de livro separado

    por espaços e intervalos de ID separados por hífens. Por exemplo: calibredb embed_metadata 1 2 10-15 23

    Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--only-formats, -f
    Apenas atualizar os metadados em arquivos do formato especificado. Especifique-o várias vezes para vários formatos. Por padrão, todos os formatos são atualizados.

SEARCH

calibredb search [options] search expression

Procura a biblioteca para o termo de pesquisa específicado, retornando uma lista separada por vírgula de ids de livros resultantes da expressão de busca. O formato de saída é utilizado em outros comandos que aceitam uma lista de ids como entrada.

O comando de expressão poder ser qualquer coisa da poderosa consulta de busca do calibre por exemplo: author:asimov title:robot

Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For example: "/some path/with spaces"

--limit, -l
    O número máximo de resultados para retornar. O padrão é todos os resultados.

AUTHOR
Kovid Goyal

COPYRIGHT
Kovid Goyal