calibredb

calibredb command [options] [arguments]

calibredb est l’interface en ligne de commande de la base de données de calibre. Elle a plusieurs sous-commandes, documentées ci-dessous.

La commande :calibredb peut être utilisée pour manipuler soit une base de données de calibre spécifiée par le chemin ou calibre Serveur de contenu fonctionnant soit en local soit sur Internet. Vous pouvez lancer calibre Serveur de contenu en utilisant soit la commande calibre-server. ou dans le programme principal de calibre, cliquer sur Connecter/partager  →  Démarrer le serveur de contenu. Puisque calibredb peut apporter des modifications à vos bibliothèques vous devez d’abord configurer l’authentification sur le serveur. Là il y a deux façons de le faire :

  • Si vous prévoyez de vous connecter uniquement à un serveur fonctionnant sur le même ordinateur,

vous pouvez simplement utiliser l’option « –enable-local-write » du Serveur de contenu pour permettre à tout programme, y compris calibredb, de fonctionner sur l’ordinateur local pour apporter des modifications aux données de calibre. Lors de l’exécution le serveur du programme principal de calibre, cette option se trouve sous Préférences → Partage sur le net → Avancé. Soyez toutefois prudent, car certains navigateurs, principalement Firefox, permettent à des sites Web arbitraires d’accéder également aux serveurs locaux. Si vous utilisez Firefox, il est préférable de configurer un nom d’utilisateur et un mot de passe, comme décrit ci-dessous. La restriction d’accès au réseau local n’a toujours pas été mise en œuvre dans la version 149 de Firefox.

  • Si vous souhaitez activer l’accès à Internet, vous devez le configurer

sur le serveur et utilisez les options --username et --password. pour donner accès à calibredb. Vous pouvez configurer l’authentification de l’utilisateur pour calibre-server en utilisant la commande --enable-auth. et en utilisant l’option « –manage-users » pour créer les comptes utilisateurs. Si vous exécutez le serveur à partir du programme principal de calibre, utilisez l’option Préférences → Partage sur le net → Nom d’utilisateur/mot de passe requis.

Pour vous connecter à un serveur de contenu en cours d’exécution, passez l’URL du serveur l’option --with-library, voir la documentation de cette option pour des détails et exemples.

OPTIONS GLOBALES

--help, -h

affiche ce message d'aide et quitte

--library-path, --with-library

Chemin vers la bibliothèque calibre. Par défaut utilise le chemin enregistré dans les paramètres. Vous pouvez vous connecter à un Serveur de contenu calibre pour effectuer des actions sur des bibliothèques distantes. Pour faire cela utiliser une URL de la forme : http://hostname:port/#library_id par exemple, http://localhost:8080/#mylibrary est l'identifiant de la bibliothèque à laquelle vous vous voulez cous connecter sur le Serveur de Contenu. Vous pouvez utiliser la la valeur spéciale library_id - pour obtenir une liste des bibliothèques disponibles sur le serveur. Pour plus de détails sur comment paramétrer l'accès via un Serveur de Contenu, voir https://manual.calibre-ebook.com/fr/generated/fr/calibredb.html.

--password

Mot de passe pour la connexion à un Serveur de contenu calibre. Pour lire le mot de passe en entrée standard, utilisez la valeur spéciale : <stdin>. Pour lire le mot de passe à partir d'un fichier, utilisez : <f:/path/to/file>. (c.a.d <f: suivi du chemin complet du fichier et ajouter >). Les chevrons (< ou >) ci-dessus sont obligatoires, n'oubliez pas de les échapper ou d'utiliser des guillemets pour votre shell.

--timeout

Le délai d'attente, en secondes, lors de la connexion à une bibliothèque calibre sur le réseau. La valeur par défaut est de deux minutes.

--username

Nom d'utilisateur pour la connexion au Serveur de contenu calibre

--version

affiche le numéro de version du logiciel et quitte

list

calibredb list [options]

Lister les livres disponibles dans la base Calibre.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--ascending

Trier les résultats dans l’ordre ascendant

--fields, -f

Les champs à afficher quand on liste les livres dans la base de données. Devrait être une liste de champs séparés par une virgule. Champs disponibles : author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, template, timestamp, title, uuid Par défaut : title,authors. Le champ spécial "all" peut être utiliser pour sélectionner tous les champs. En supplément des champs intégrés ci-dessous, les champs personnalisés sont également disponibles en tant que *field_name, par exemple, pour un champ personnalisé #notation, utiliser le nom : *notation

--for-machine

Générer une sortie au format JSON, qui est plus commode pour une analyse machine. Entraîne les options largeur de ligne et séparateur à être ignorés.

--limit

Le maximum de résultats à afficher. Par défaut : tous

--line-width, -w

Largeur maximum pour une seule ligne en sortie. Par défaut détecte la taille de l’écran.

--prefix

Préfixe pour tous les chemins vers des fichiers. Par défaut : chemin absolu du dossier de la bibliothèque.

Filtrer les résultats à l’aide de la requête de recherche. Pour le format de la requête de recherche, veuillez consulter la section recherche dans le manuel utilisateur. Par défaut n’effectue aucun filtrage

--separator

La chaîne utilisée pour séparer des champs. Par défaut : un espace

--sort-by

Le champ selon lequel trier les résultats. Vous pouvez spécifier plusieurs champs en les séparant par des virgules. Champs disponibles : author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, template, timestamp, title, uuid Par défaut : id. En supplément des champs intégrés ci-dessous, les champs personnalisés sont également disponibles en tant que *field_name, par exemple, pour un champ personnalisé #notation, utiliser le nom : *notation

--template

Le modèle à exécuter si « template » figure dans la liste des champs. Notez que les modèles sont ignorés lors de la connexion à un serveur Calibre. Par défaut : None

--template_file, -t

Chemin d'accès à un fichier contenant le modèle à exécuter si "template" figure dans la liste des champs. Default : None

--template_heading

Intitulé de la colonne du modèle. Valeur par défaut : template. Cette option est ignorée si l'option --for-machine est définie.

add

calibredb add [options] fichier1 fichier2 fichier3 …

Ajouter les fichiers spécifiés comme livre numérique à la base de données. Vous pouvez aussi spécifier des dossiers, voir ci-dessous les options relatives aux dossiers.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--authors, -a

Définissez les auteurs du(es) livre(s) ajouté(s)

--automerge, -m

Si des livres dont les titres et les auteurs sont similaires sont trouvés, fusionnez automatiquement les formats (fichiers) entrants dans les fiches de livres existantes. Une valeur "ignore" signifie que les formats en double sont éliminés. Une valeur "overwrite" signifie que les formats en double dans la bibliothèque sont écrasés avec les fichiers nouvellement ajoutés. Une valeur de "new_record" signifie que les formats dupliqués sont placés dans une nouvelle fiche de livre.

--cover, -c

Chemin à utiliser pour la couverture du livre ajouté

--duplicates, -d

Ajouter des livres à la base de données même s'ils existent déjà. La comparaison se fait sur la base des titres des livres et des auteurs. Notez que l'option --automerge est prioritaire.

--empty, -e

Ajouter un livre vide (un livre sans formats)

--identifier, -I

Paramètres les identifiants pour ce livre, par ex. -I asin:XXX -I isbn:YYY

--isbn, -i

Définir l'ISBN du(es) livre(s) ajouté(s)

--languages, -l

Une liste de langages séparés par une virgule (mieux d'utiliser les codes de langue IS0639, ainsi certains noms de langues peuvent aussi être reconnus)

--series, -s

Définir les séries du(es) livre(s) ajouté(s)

--series-index, -S

Assigne le numéro de la série de(s) livre(s) ajoutés

--tags, -T

Définir les étiquettes du(es) livre(s) ajouté(s)

--title, -t

Définir le titre du(es) livre(s) ajouté(s)

AJOUTER A PARTIR DES DOSSIERS

Options pour contrôler l’ajout de livres à partir de dossiers. Par défaut seuls les fichiers qui ont des extensions de type livre numérique connues sont ajoutés.

--add

Un motif de nom de fichier (glob), les fichiers correspondant à ce motif seront ajoutés lors de la recherche de fichiers dans les dossiers, même s'ils ne sont pas d'un type de fichier de livre numérique connu. Peut être spécifié plusieurs fois pour plusieurs motifs.

--ignore

Un motif de nom de fichier (glob), les fichiers correspondant à ce motif seront ignorés lors de la recherche de fichiers dans les dossiers. Peut être spécifié plusieurs fois pour plusieurs motifs. Par exemple : *.pdf ignorera tous les fichiers PDF

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

Suppose que chaque dossier dispose d’un seul livre logique et que tous les fichiers dans celui-ci sont des formats différents de ce même livre.

--recurse, -r

Traite les dossiers récursivement

remove

calibredb supprime les ids

Supprime les livres identifiés par leurs ids de la base de données. Les ids devraient être une liste de nombres id séparés par des virgules (vous pouvez obtenir les numéros id en utilisant la commande search). Par exemple, 23,34,57-85 (quand un intervalle est précisé, le dernier nombre dans l’intervalle n’est pas inclus).

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--permanent

Ne pas utiliser la corbeille

add_format

calibredb add_format [options] id ebook_file

Ajouter le livre numérique dans ebook_file aux formats disponibles pour le livre logique identifié par l’id. Vous pouvez obtenir l’id à l’aide de la commande search. Si le format existe déjà, il est remplacé, à moins que l’option ne pas remplacer est spécifiée.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--as-extra-data-file

Ajouter le fichier en tant que fichier de données supplémentaire au e-livre, et non en tant que format ebook

--dont-replace

Ne pas remplacer le format s'il existe déjà

remove_format

calibredb remove_format [options] id fmt

Supprime le format fmt du livre logique identifié par l’id. Vous pouvez obtenir l’identifiant à l’aide de la commande search. fmt devrait être une extension de fichier comme LRF, TXT ou EPUB. Si le fichier logique n’a pas de format fmt disponible, aucune action n’est effectuée.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

show_metadata

calibredb show_metadata [options] id

Afficher les métadonnées stockées dans la base de données calibre pour le livre identifié par l’id. id est un identifiant obtenu à l’aide de la commande search.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--as-opf

Imprimer les métadonnées dans un formulaire OPF (XML)

set_metadata

calibredb set_metadata [options] book_id [/path/to/metadata.opf]
Place les métadonnées stockées dans la base de données de calibre pour le livre identifié par

book_id à partir du fichier OPF metadata.opf. book_id est un numéro d’id issu de la commande rechercher. Vous pouvez obtenir un aperçu rapide du format OPF à

l’aide du commutateur –as-opf de la commande show_metadata. Vous pouvez également placer les métadonnées de champs individuels avec l’option –field. Si vous utilisez l’option –field, il n’est pas nécessaire de spécifier un fichier OPF.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--field, -f

Le champ à définir. Le format est nom_champ:valeur, par exemple: --field tags:tag1,tag2. Utilisez --list-fields pour récupérer une liste de tous les noms de champs. Vous pouvez spécifier cette option plusieurs fois pour définir plusieurs champs. Note: pour le champs "languages" (langues), vous devez utiliser les codes de langues ISO639 (par exemple, en pour Anglais, fr pour Français, et ainsi de suite). Pour les identifiants (identifiers), la syntaxe est --field identifiers:isbn:XXXX,doi:YYYYY. Pour les champs booléens (oui/non), utilisez "true" (vrai) ou "false" (faux) ou "yes" (oui) et "no" (non).

--list-fields, -l

Lister les champs de métadonnées pouvant être utilisés avec l'option --field

export

calibredb export [options] ids

Exporter les livres spécifiés par ids (une liste séparée par des virgules) vers le système de fichiers. L’opération d”export enregistre tous les formats du livre, la couverture et les métadonnées (dans n’importe quel un fichier OPF). Tous les fichiers de données supplémentaires associés au livre sont également enregistrés. Vous pouvez obtenir les numéros id à partir de la commande search.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--all

Exporter tous les livres dans la base, en ignorant la liste des ids.

--dont-asciiize

Faire en sorte que le calibre convertisse tous les caractères non anglais en équivalents anglais pour les noms de fichiers. Ceci est utile si vous enregistrez sur un ancien système de fichiers qui ne prend pas entièrement en charge les noms de fichiers Unicode. Spécifier cette bascule désactivera ce comportement.

--dont-save-cover

Normalement, calibre enregistrera la couverture dans un fichier séparé avec les fichiers du livre numérique. Spécifier cette bascule désactivera ce comportement.

--dont-save-extra-files

Enregistrez tous les fichiers de données associés au livre lors de l'enregistrement du livre Spécifier cette bascule désactivera ce comportement.

--dont-update-metadata

En temps normal calibre mettra à jour les métadonnées des fichiers sauvegardés à partir du contenu de la bibliothèque calibre. L’enregistrement prendra davantage de temps. Spécifier cette bascule désactivera ce comportement.

--dont-write-opf

Normalement, calibre écrira les métadonnées dans un fichier OPF séparé avec les fichiers de livre numérique actuels. Spécifier cette bascule désactivera ce comportement.

--formats

Liste séparée par des virgules de formats à enregistrer pour chaque livre. Par défaut tous les formats disponibles sont sauvegardés.

--progress

Signaler l'avancement

--replace-whitespace

Remplacer les espaces par des underscores.

--single-dir

Exporter tous les livres vers un dossier unique

--template

Modèle pour contrôler le nom des fichier et la structure des dossiers d’enregistrement des fichiers. Par défaut : "{author_sort}/{title}/{title} - {authors}" qui va sauvegarder les livres dans un sous-dossier par auteur avec des noms de fichiers contenant le titre et l’auteur. Les variables disponibles sont  : {author_sort, authors, id, isbn, languages, last_modified, pages, pubdate, publisher, rating, series, series_index, tags, timestamp, title}

--timefmt

Le format suivant lequel afficher les dates. %d - jour, %b - mois, %m - numéro de mois, %Y - année. Par défaut : %b, %Y

--to-dir

Exporter les livres vers le dossier spécifié. Par défaut : .

--to-lowercase

Convertir les chemins en minuscule.

catalog

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

Exporter un catalogue dans un format spécifié par path/to/destination extension. Les options contrôlent comment comment les entées sont affichées dans la sorie du catalogue généré. Noter que différents formats de catalogue supportent différents ensembles d’options. Pour

voir les différentes options, indiquez le nom du fichier de sortie et ensuite l’option –help.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--ids, -i

Liste séparée par des virgules d’identifiants de base de données à cataloguer. Si déclaré, --search est ignoré. Par défaut : all

Filtrer les résultats par la requête de recherche. Pour le format de la requête de recherche, veuillez consulter la section recherche dans le Manuel Utilisateur. Par défaut: Pas de filtre

--verbose, -v

Affiche des informations détaillées. Utile pour le débogage

EPUB OPTIONS

--catalog-title

Titre du catalogue généré utilisé comme titre dans les métadonnées. Par défaut : 'My Books' S’applique aux formats de sortie : AZW3, EPUB, MOBI

--cross-reference-authors

Crée des références croisées dans la section Auteurs pour les livres avec des auteurs multiples. Par défaut: 'False' S'applique aux formats de sortie: AZW3, EPUB et MOBI

--debug-pipeline

Enregistre la sortie à différentes étapes du processus de conversion vers le dossier spécifié. Utile si vous n'êtes pas sûr de l'étape de la conversion à laquelle se produit le bogue. Par défaut : 'None' S’applique aux formats de sortie : AZW3, EPUB, MOBI

--exclude-genre

Expression régulière décrivant les étiquettes à exclure comme genres. Par défaut : '[.+]|^+$' exclut les étiquettes entre crochets, par ex. '[Project Gutenberg]', et '+', l'étiquette par défaut pour les livres lus. S’applique aux formats de sortie : AZW3, EPUB, MOBI

--exclusion-rules

Indique les règles à appliquer pour exclure des livres du catalogue généré. Le modèle pour une règle d'exclusion est ('<nom de la règle>','Étiquettes','<liste d'étiquettes séparées par des virgules>') or ('<nom de la règle>','<nom de colonne>','<valeur>'). Par exemple: (('Livres archivés','#statut','Archivé'),) exclura les livres qui ont la valeur 'Archivé' dans la colonne 'statut'. Quand plusieurs règles sont définies, toutes les règles seront appliquées. Par défaut: "(('Catalogs','Tags','Catalog'),)" S'applique aux formats de sortie AZW3, EPUB, MOBI

--generate-authors

Inclut la section 'Auteurs' dans le catalogue. Par défaut : 'False' S’applique aux formats de sortie : AZW3, EPUB, MOBI

--generate-descriptions

Inclut la section 'Descriptions' dans le catalogue. Par défaut : 'False' S’applique aux formats de sortie : AZW3, EPUB, MOBI

--generate-genres

Inclut la section 'Genres' dans le catalogue. Par défaut : 'False' S’applique aux formats de sortie : AZW3, EPUB, MOBI

--generate-recently-added

Inclut la section 'Ajoutés récemment' dans le catalogue. Par défaut : 'False' S’applique aux formats de sortie : AZW3, EPUB, MOBI

--generate-series

Inclut la section 'Series' dans le catalogue. Par défaut : 'False' S’applique aux formats de sortie : AZW3, EPUB, MOBI

--generate-titles

Inclut la section 'Titres' dans le catalogue. Par défaut : 'False' S’applique aux formats de sortie : AZW3, EPUB, MOBI

--genre-source-field

Champ source pour la section 'Genres'. Par défaut : 'Étiquettes' S’applique aux formats de sortie : AZW3, EPUB, MOBI

--header-note-source-field

Champ personnalisé contenant une note de texte à insérer dans l'en-tête de Description. Par défaut : '' S’applique aux formats de sortie : AZW3, EPUB, MOBI

--merge-comments-rule

#<custom field> : spécifier [before|after]:[True|False] : <custom field> Champ personnalisé contenant des notes à fusionner avec les commentaires [before|after] Placement des notes par rapport au commentaires [True|False] - Une ligne horizontale est insérée entre les notes et les commentaires Par défaut : '::' S’applique aux formats de sortie : AZW3, EPUB, MOBI

--output-profile

Spécifie le profil de sortie. Dans certains cas, un profil de sortie est requis pour optimiser le rendu en fonction du périphérique. Par exemple, 'kindle' ou 'kindle_dx' créent une table des matières structurée avec des sections et des articles. Par défaut: 'None' S'applique aux formats de sortie: AZW3, EPUB, MOBI

--prefix-rules

Indique les règles utilisées pour inclure des préfixes qui indiquent qu'un livre est lu, qu'il est sur votre liste d'envies et d'autres indications personnalisées. Le modèle pour une règle de préfixe est: ('<rule name>','<source field>','<pattern>','<prefix>'). Quand plusieurs règles sont définies, toutes les règles s'appliquent. Par défaut: "(('Read books','tags','+','✓'),('Wishlist item','tags','Wishlist','×'))" S'applique aux formats de sortie AZW3, EPUB, MOBI

--preset

Employe un préréglage appelé créé avec le constructeur de Catalogue GUI. Un préréglage spécifie tous les paramètres pour construire un catalogue. Par défaut: 'None' S'applique aux formats de sortie AZW3, EPUB, MOBI

--thumb-width

Indice de taille (en pouces) pour les couvertures de livres dans le catalogue. Gamme : 1.0 - 2.0 Par défaut : '1.0' S’applique aux formats de sortie : AZW3, EPUB, MOBI

--use-existing-cover

Remplace la couverture existante lorsque le catalogue est généré. Par défaut : 'False' S’applique aux formats de sortie : AZW3, EPUB, MOBI

saved_searches

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

Gère les recherches sauvegardées stockées dans la base de données. Si vous essayez d’ajouter une requête avec un nom préexistant, elle sera remplacée.

Syntaxe pour l’affichage de la liste, action par défaut :

calibredb saved_searches list

Syntaxe pour l’ajout :

calibredb saved_searches add search_name search_expression

Syntaxe pour la suppression :

calibredb saved_searches remove search_name

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

add_custom_column

calibredb add_custom_column [options] label name datatype

Créer une colonne personnalisée. label correspond au nom de la colonne pour le programme. Ne doit pas contenir d’espace ou de deux-points. name est le nom de la colonne pour l’utilisateur. datatype est à choisir parmi : bool, comments, composite, datetime, enumeration, float, int, rating, series, text

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--display

Un dictionnaire des options pour personnaliser la manière dont les données dans cette colonne seront interprétées. C'est une chaîne JSON. Pour des colonnes d'énumération, employez --display"{\ "enum_values\ ":[\ "val1\ ", \ "val2\ "]}" Il y a beaucoup d'options qui peuvent entrer dans la variable d'affichage.Les options par type de colonne sont : 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 La meilleure manière de trouver des combinaisons légitimes est de créer dans le GUI une colonne personnalisée du type approprié et d'ensuite de regarder dans la sauvegarde de l'OPF d'un livre (assurez-vous qu'un nouvel OPF a été créé depuis que la colonne a été ajoutée). Vous verrez le JSON pour l' « affichage » pour la nouvelle colonne dans l'OPF.

--is-multiple

Cette colonne stocke les étiquettes comme des données (par exemple des valeurs multiples séparées par des virgules). Appliqué seulement si le type de donnée est du texte.

custom_columns

calibredb custom_columns [options]

Liste des colonnes personnalisées disponibles. Affiche les entêtes de colonne et les ids.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--details, -d

Afficher les détails pour chaque colonne.

remove_custom_column

calibredb remove_custom_column [options] label


Enlever la colonne personnalisée identifiée par le libellé. Vous pouvez afficher
les colonnes disponibles avec la commande custom_columns.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--force, -f

Ne pas demander de confirmation

set_custom

calibredb set_custom [options] valeur de l’id de la colonne

Définir la valeur d’une colonne personnalisée pour le livre identifié par l’id. Vous pouvez obtenir une liste d’ids en utilisant la commande search. Vous pouvez obtenir une liste des noms de colonnes personnalisés en utilisant la commande custom_columns.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--append, -a

Si la colonne stocke des valeurs multiples, ajouter les valeurs spécifiées à celles existantes, au lieu de les remplacer.

restore_database

calibredb restore_database [options]

Restaure la base de données à partir des métadonnées stockées dans les fichiers OPF présents dans chaque dossier de la bibliothèque calibre. Ceci est utile si votre fichier metadata.db a été corrompu.

ATTENTION : cette commande régénère complètement votre base de données. Vous perdrez toutes les recherches sauvegardées, les catégories utilisateur, les tableaux de connexions, les réglages de conversion par livre et les recettes personnalisées. Les métadonnées restaurées seront aussi précises que ce qui sera trouvé dans les fichiers OPF.

Le code de sortie est 0 si la restauration a réussi, 1 si elle a complètement échoué et 2 si la base de données a été restaurée mais que certains livres ou d’autres données n’ont pas pu l’être.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--really-do-it, -r

Effectuer réellement la récupération. La commande ne sera pas exécutée si cette option n’est pas spécifiée.

check_library

calibredb check_library [options]

Réalise des vérifications sur le système de fichiers représentant une bibliothèque. Les rapports sont invalid_titles, extra_titles, invalid_authors, extra_authors, missing_formats, extra_formats, extra_files, missing_covers, extra_covers, malformed_formats, malformed_paths, failed_folders

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--csv, -c

Sortie en CSV

--ignore_extensions, -e

Liste d’extensions à ignorer séparées par des virgules. Par défaut: toutes

--ignore_names, -n

Liste de noms à ignorer séparés par des virgules. Par défaut : tous

--report, -r

Liste de rapports séparés par des virgules. Par défaut : tous

--vacuum-fts-db

Nettoyer la base de données de recherche en texte intégral. Cette opération peut être très lente et gourmande en mémoire, en fonction de la taille de la base de données.

list_categories

calibredb list_categories [options]

Produit un rapport sur les informations des catégories dans la base de données. Les informations sont les équivalents de ce qui est affiché dans le Navigateur d’étiquettes.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--categories, -r

Liste de catégories de noms de recherche séparées par des virgules. Par défaut : tous

--csv, -c

Sortie en CSV

--dialect

Le type de fichier CSV à produire. Choix : excel, excel-tab, unix

--item_count, -i

Sort seulement le nombre d’articles dans une catégorie au lieu du nombre d’occurrences par article à l’intérieur de la catégorie

--width, -w

Largeur maximum pour une seule ligne en sortie. Par défaut détecte la taille de l’écran.

backup_metadata

calibredb backup_metadata [options]

Sauvegarde les métadonnées stockées dans la base de données dans les fichiers OPF individuels dans chaque dossier de livres. Ceci se fait normalement automatiquement, mais vous pouvez lancer cette commande pour forcer la régénération des fichiers OPF, avec l’option –all.

Notez qu’il y a normalement aucun besoin de faire ceci, car les fichiers OPF sont mis à jour automatiquement, chaque fois que les métadonnées sont changées.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--all

Normalement, cette commande opère seulement sur les livres qui ont des fichiers OPF périmés. Cette option la fait opérer sur tous les livres.

clone

calibredb clone path/to/new/library

Crée un clone de la bibliothèque active. Vous obtiendrez une bibliothèque vide qui a exactement les même colonnes personnalisées, Bibliothèques virtuelles et autres paramétrages de la bibliothèque active.

Cette bibliothèque clonée ne contiendra aucun livre. Si vous voulez avoir une copie complète, contenu inclus, le plus simple est de copier manuellement le dossier contenant cette bibliothèque.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

embed_metadata

calibredb embed_metadata [options] book_id

Met à jour les métadonnées dans les fichiers de livre stockées dans la bibliothèque calibre depuis les métadonnées de la base de données calibre. Normalement, les métadonnées sont mises à jour uniquement quand des fichiers sont exportés depuis calibre, cette commande est utile si vous voulez que les fichiers soient mis à jour sur place. Notez que les différents formats de fichiers supportent différentes quantités de métadonnées. Vous pouvez utiliser la valeur spéciale “all” de book_id pour mettre à jour les métadonnées dans tous les livres. Vous pouvez aussi spécifier beaucoup d’ids de livres séparés par des espaces et des ensembles d’ids séparés par des traits d’union : calibredb embed_metadata 1 2 10-15 23

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--only-formats, -f

Met uniquement à jour les métadonnées dans les fichiers au format spécifié. Spécifier le plusieurs fois pour de multiples formats. Par défaut, tous les formats sont mis à jour.

fts_index

calibredb fts_index [options] enable/disable/status/reindex

Contrôle le processus d’indexation de la recherche intégrale du texte.

enable Active l’indexation RIT disable Désactive l’indexation RIT pour cette bibliothèque. status Affiche le statut actuel de l’indexation reindex Peut être utilisé pour réindexer soit des livres particuliers ou la bibliothèque entière. Pour réindexer des livres particuliers spécifiez les identifiants des livres comme arguments supplémentaires après la commande reindex. Si aucun identifiant de livre n’est spécifié, la bibliothèque entière est réindexée.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--indexing-speed

La vitesse d'indexation. Utiliser rapide pour une indexation rapide utilisant toutes les ressources de votre ordinateur et lent pour une indexation moins gourmande en ressources. Noter que la vitesse est réinitialisée à lent après chaque demande.

--wait-for-completion

Attendre que tous les livres soient indexés, en montrant périodiquement la progression de l'indexation

notes

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

Gère les notes associées à des éléments tels que les auteurs, les séries, les balises et les éditeurs. FIELD correspond au nom de recherche du champ, par exemple : authors, series, tags, publisher ou #mycolumn. ITEM correspond au nom de l’élément, par exemple le nom d’un auteur. La correspondance des éléments ne tient pas compte de la casse.

Répertorier les éléments comportant des notes, éventuellement uniquement ceux du champ spécifié. Il s’agit de l’action par défaut :

calibredb notes list [FIELD]

Effectuez une recherche dans le texte des notes en utilisant la même syntaxe de recherche en texte intégral SQLite que l’outil « Parcourir les notes » de Calibre. Affichez le champ, le nom de l’élément et un extrait pour chaque résultat. Utilisez l’option –field pour rechercher uniquement dans les notes d’un champ particulier :

calibredb notes search « search expression » calibredb notes search –field authors « search expression »

Afficher la note d’un élément au format Markdown, ou avec l’option –as-html sous forme de document HTML avec toutes les images intégrées, adapté à une utilisation avec l’option set :

calibredb notes show FIELD ITEM

Remplacer la note d’un élément par le contenu d’un fichier HTML. Utilisez - pour lire le code HTML à partir de l’entrée standard. Les images sont intégrées sous forme de données encodées en base64 : les URL sont ajoutées à la note, tant pour les bibliothèques locales que pour les bibliothèques distantes. Lorsque vous utilisez une bibliothèque locale et que vous lisez à partir d’un fichier, les images référencées par des chemins relatifs par rapport au fichier sont également ajoutées :

calibredb notes set FIELD ITEM FICHIER

Supprime la note d’un élément :

calibredb notes remove FIELD ITEM

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--as-html

Lors de l'affichage d'une note, l'afficher au format HTML plutôt qu'au format Markdown

--field

Lorsque vous effectuez une recherche dans les notes, limitez celle-ci à ce champ, par exemple : authors, tags ou #mycolumn

items

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

Renommer ou supprimer des éléments tels que les auteurs, les balises, les séries et les éditeurs dans tous les livres, de la même manière que les actions « Gérer les auteurs, les balises, etc. » de l’interface de Calibre. FIELD correspond au nom de référence du champ, par exemple : authors, tags, series, publisher ou #mycolumn. La correspondance des éléments se fait sans distinction de majuscules/minuscules.

Renommer un élément. Si un élément nommé NEW_NAME existe déjà, les deux éléments sont fusionnés. Pour les champs contenant plusieurs valeurs, NEW_NAME peut contenir plus d’une valeur, séparées par le séparateur du champ, par exemple une virgule pour les balises. L’élément est alors remplacé par toutes les valeurs :

calibredb items rename FIELD ITEM NEW_NAME

Supprimer un ou plusieurs éléments de tous les livres. Les auteurs ne peuvent pas être supprimés :

calibredb items remove FIELD ITEM [ITEM …]

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

Ne modifier que les livres correspondant à l'expression de recherche indiquée, par exemple : tags:"=Fiction"

virtual_libraries

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

Gère les bibliothèques virtuelles de cette bibliothèque. Une bibliothèque virtuelle est une recherche qui se comporte comme si la bibliothèque ne contenait que les livres correspondant à cette recherche. Pour lister ou rechercher les livres d’une bibliothèque virtuelle, utilisez : calibredb search “vl: »nom »”

Répertorier les bibliothèques virtuelles, avec leurs recherches et le nombre de livres. Il s’agit de l’action par défaut :

calibredb virtual_libraries list

Créer une bibliothèque virtuelle à partir d’une recherche :

calibredb virtual_libraries add NAME SEARCH_EXPRESSION

Renommer une bibliothèque virtuelle :

calibredb virtual_libraries rename NAME NEW_NAME

Supprimer des bibliothèques virtuelles ; les livres qu’elles contiennent ne sont pas modifiés :

calibredb virtual_libraries remove NAME [NAME …]

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--for-machine

Générer une sortie au format JSON, ce format étant mieux adapté à l'analyse automatique.

--replace

Remplacer la recherche d'une bibliothèque virtuelle existante portant le même nom lors de l'ajout

annotations

%pannotations [options] [list|search|export|import|remove]

Gère les annotations, c’est-à-dire les passages surlignés et les signets, des livres, telles qu’elles ont été créées dans la visionneuse de livres électroniques Calibre ou synchronisées depuis d’autres applications.

Afficher la liste des annotations, avec leurs identifiants. Il s’agit de l’action par défaut :

calibredb annotations list

Rechercher du texte surligné, des notes d’annotation et des titres de signets en utilisant la même syntaxe de recherche en texte intégral SQLite que l’outil Parcourir les annotations. Les résultats sont classés par pertinence et incluent les identifiants d’annotation, les titres des livres et les extraits correspondants. Utilisez –search pour limiter les livres, –type pour limiter le type d’annotation, –user-type et –annotation-user pour limiter l’utilisateur, –no-stemming pour rechercher des formes de mots exactes, ou –format json pour obtenir un tableau JSON de résultats comprenant les données d’annotation et les extraits :

calibredb annotations search « search expression »

Exportez les annotations au format texte brut, Markdown ou JSON, regroupées par livre. Le fichier JSON correspond à la même collection d”annotations Calibre que celle créée par le bouton Exporter de l’outil Parcourir les annotations :

calibredb annotations export

Importez une collection d”annotations Calibre exportée au format JSON par cette commande ou par l’outil Parcourir les annotations. La collection doit contenir les annotations d’un seul livre. BOOK_ID correspond à l’identifiant du livre de destination, et non à l’identifiant stocké dans le fichier. Seules les annotations au format FORMAT sont importées, celles aux autres formats sont ignorées. Le format FORMAT doit exister dans le livre de destination. Utilisez la même édition du livre afin que les positions correspondent :

calibredb annotations import BOOK_ID FORMAT FILE

Utilisez - pour FILE afin de lire depuis l’entrée standard. L’ensemble de la collection est validé avant l’importation. Les annotations sont fusionnées avec celles existantes selon les règles de la visionneuse : les surlignages sont mis en correspondance par UUID et les signets par titre, et l’horodatage le plus récent prévaut. Les importations répétées ne créent pas de doublons. Les annotations et positions de lecture non liées sont conservées.

Par défaut, les annotations sont importées dans celles de la visionneuse de livres électroniques de Calibre. Utilisez –user-type web –annotation-user USER pour les importer à la place dans celles d’un utilisateur du serveur de contenu. Les collections exportées enregistrent l’utilisateur auquel appartiennent les annotations, et si une collection contient des annotations de plus d’un utilisateur, elle est rejetée. Utilisez les options –user-type et –annotation-user lors de l’exportation, pour exporter les annotations d’un seul utilisateur.

Supprimez définitivement les annotations dont les identifiants sont spécifiés, comme indiqué par la commande list :

calibredb annotations remove ID [ID …]

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--annotation-user

Afficher, rechercher ou exporter uniquement les annotations de l'utilisateur spécifié. Pour l'importation, l'utilisateur du serveur de contenu pour lequel les annotations doivent être importées doit être spécifié à l'aide de l'option --user-type web. Notez qu'il peut s'agir de n'importe quel utilisateur, et pas uniquement de celui utilisé pour se connecter à une bibliothèque distante.

--format, -f

Le format d'exportation, l'un des suivants : text, markdown, json. Pour la recherche : texte ou json. Valeur par défaut : text

--no-stemming

Pour la recherche, privilégiez la correspondance exacte des formes des mots plutôt que celle des racines

Afficher, rechercher ou exporter uniquement les annotations des livres correspondant à la requête de recherche indiquée, par exemple : --search "series:Foundation"

--type, -t

Afficher, rechercher ou exporter uniquement les annotations du type spécifié, parmi les suivantes : highlight, bookmark

--user-type

Afficher, rechercher ou exporter uniquement les annotations du type d'utilisateur spécifié. Pour l'importation, indiquez le type d'utilisateur pour lequel vous souhaitez importer les annotations : la visionneuse de livre numérique Calibre (local) ou un utilisateur du serveur de contenu (Web). La valeur par défaut pour l'importation est local.

trash

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

Gère les livres et les formats qui ont été supprimés et placés dans la corbeille. Les éléments de la corbeille sont automatiquement supprimés de manière définitive au bout de quelques jours. IDS est une liste d’identifiants de livres séparés par des virgules, comme pour la commande remove, par exemple : 23,34,57-85 (lorsqu’on spécifie une plage, le dernier numéro de la plage n’est pas inclus).

Afficher la liste des livres et formats supprimés, en commençant par les plus récents, avec l’heure de leur suppression en heure locale. Les formats supprimés de livres qui n’existent plus sont marqués comme non restaurables, ils ne peuvent être que supprimés. Avec –for-machine, les heures sont exprimées en UTC :

calibredb trash list

Restaurer les livres supprimés, ou avec l’option –formats, les formats supprimés des livres :

calibredb trash restore IDS

Supprimer définitivement des entrées de la corbeille :

calibredb trash delete IDS

Supprimer définitivement tout le contenu de la corbeille :

calibredb trash empty

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--for-machine

Générer une sortie au format JSON pour l'action list, ce format étant mieux adapté à l'analyse automatique.

--formats

Agir sur les formats supprimés des livres indiqués, plutôt que sur les livres supprimés

data_files

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

Gère les fichiers de données supplémentaires associés à un livre, dans des bibliothèques locales ou distantes. Les noms sont relatifs au répertoire de données du livre. Utilisez / pour les sous-répertoires ; est également accepté. Les fichiers dont le nom contient un sont répertoriés, mais ne peuvent pas être gérés autrement. Les formats de livres électroniques, les couvertures et les fichiers metadata.opf ne sont pas accessibles via cette commande. Les bibliothèques distantes nécessitent un compte disposant d’un accès en écriture, comme pour les autres commandes de gestion, et ne prennent pas en charge les comptes soumis à des restrictions de recherche par bibliothèque.

Répertorie les noms de fichiers, leur taille en octets et leur date de modification (en secondes depuis l’époque Unix). Utilisez –for-machine pour une sortie au format JSON :

calibredb data_files list BOOK_ID

Ajouter un fichier en utilisant son nom de base, ou –name pour spécifier un nom ou un sous-répertoire. Les fichiers existants ne sont pas remplacés sauf si –replace est spécifié. Cette option est également disponible via add_format –as-extra-data-file :

calibredb data_files add BOOK_ID FILE

Enregistrer un fichier de données dans –output sur la machine locale. Les fichiers de sortie existants ne sont pas remplacés, sauf si l’option –replace est spécifiée :

calibredb data_files get BOOK_ID NAME –output FILE

Renommer un fichier. Les destinations existantes ne sont pas remplacées, sauf si l’option –replace est activée :

calibredb data_files rename BOOK_ID NAME NEW_NAME

Déplacer un fichier vers la corbeille du système d’exploitation. Avec l’option –permanent, supprimez-le définitivement à la place. Pour les bibliothèques distantes, cette opération s’effectue sur le serveur :

calibredb data_files remove BOOK_ID NAME

Les répertoires laissés vides par les opérations de renommage et de suppression sont supprimés. Avec les bibliothèques distantes, chaque fichier est transféré en une seule requête ; par conséquent, les fichiers très volumineux nécessitent suffisamment de mémoire tant sur le client que sur le serveur, et les téléchargements sont limités par la taille maximale des requêtes du serveur.

Chaque fois que vous passez à calibredb des arguments comportant des espaces, entourez l’argument à l’aide de guillemets. Par exemple: « /some path/with spaces »

--for-machine

Afficher la liste des fichiers au format JSON

--name

Nom à attribuer au fichier ajouté, par rapport au répertoire de données

--output

Une destination locale pour l'action get

--permanent

Supprimer définitivement le fichier de données au lieu de l'envoyer dans la corbeille

--replace

Autoriser le remplacement des fichiers existants lors de l'ajout, de la récupération ou du renommage