CALIBREDB(1) calibre CALIBREDB(1)

calibredb - calibredb

calibredb command [options] [arguments]

calibredb は、calibre データベースへのコマンドラインインタフェースです。 以下に説明するようなサブコマンドがあります。

calibredb はパスで指定した calibre データベース、またはローカルまたは インターネット上で実行中の calibre コンテンツサーバ に対して操作を行うのに 利用できます。コンテンツサーバ を起動するには calibre-server プログラムを、 使用するか、またはメインの calibre プログラム上で 接続/共有  →  コンテンツサーバを開始 をクリックします。calibredb は calibre ライブラリへの変更を行うことができるため、 まずサーバ上に認証を設定しておく必要があります。それには次の 2 種類の方法があります。

  • 同じコンピュータ上で動作するサーバにのみアクセスする予定であれば、コンテンツサーバ のオプションとして --enable-local-write を指定するだけでかまいません。これにより calibredb を含めてローカルなコンピュータ上で実行されるすべてのプログラムが calibre の のデータに変更を加えることができるようになります。サーバをメインの calibre プログラム から起動した場合、このオプションは 設定 → ネット共有 → 詳細 にあります。
  • インターネット越しの接続を許可したい場合、サーバ上にユーザアカウントを設定して --username および --password を使用して calibre へのアクセスを 許可してください。calibre-server の認証は --enable-auth オプション を使用し、--manage-users を使ってユーザアカウントを作成します。 メイン calibre からサーバを実行している場合には、環境設定 → ネット共有 → ユーザ名とパスワードを要求 を使用してください。

実行中のコンテンツサーバに接続するには、--with-library オプションにサーバへの URL を 渡します。このオプションについての詳しい説明や使用例はドキュメントを参照してください。

  • グローバルオプション
  • list
  • add
フォルダから追加
  • remove
  • add_format
  • remove_format
  • show_metadata
  • set_metadata
  • export
  • catalog
EPUB オプション
  • saved_searches
  • add_custom_column
  • custom_columns
  • remove_custom_column
  • set_custom
  • restore_database
  • check_library
  • list_categories
  • backup_metadata
  • clone
  • embed_metadata
  • search
  • fts_index
  • fts_search

グローバルオプション

このヘルプメッセージを表示して終了
calibreライブラリへのパス。デフォルトでは設定画面で指定されたpathが使用されます。リモートライブラリに対して操作を行うためにcalibreコンテンツサーバに接続することも可能です。コンテンツサーバに接続するには、http://hostname:port/#library_id の形式のURLを指定します。例えば http://localhost:8080/#mylibrary のように指定します。library_id はコンテンツサーバ上の接続したいライブラリのIDです。特殊な library_id として - を指定すると、そのサーバ上で利用可能なライブラリの一覧を表示できます。コンテンツサーバ経由でのアクセスを設定する方法について詳しくは https://manual.calibre-ebook.com/ja/generated/ja/calibredb.html を参照してください。
calibreコンテンツサーバ接続用パスワード。標準入力からパスワードを読み取るには、特殊文字 <stdin> を使ってください。パスワードをファイルから読み込むには <f:/path/to/file> を使ってください。 (例えば先頭の <f: に続けてファイルへのフルパスを記述し、最後に > で閉じます。) カギ括弧は必須です。使用するシェルによっては、必要に応じてエスケープしたり引用符で囲ってください。
ネットワーク経由でキャリバーライブラリに接続するときのタイムアウト。秒単位。デフォルトは2分です。
calibreコンテンツサーバ接続用ユーザ名
プログラムのバージョン番号を表示して終了

calibredb list [options]

calibreデータベースに存在する本のリスト

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

昇順に並び替え
データベース中の本の一覧を表示するときに表示するフィールド。フィールドをカンマ区切りで指定します。 指定可能なフィールド: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, timestamp, title, uuid デフォルト: title,authors 特殊フィールド名 "all" を指定するとすべてのフィールドを選択します。上記のビルトインフィールドの他、カスタムフィールドも *field_name として指定可能です。たとえば、カスタムフィールド #rating を表示させたいときには *rating と指定してください。
JSON形式で出力します。JSONはコンピュータでの処理により適した形式です。このオプションを指定すると行幅とセパレーターオプションは無視されます。
表示する最大結果数。デフォルトはすべて
出力ファイル中の、1行の最大の長さ。デフォルトは画面サイズから判別。
すべてのファイルパスのプレフィックス。デフォルトはライブラリフォルダへの絶対パス。
検索文字列で結果を絞り込む。検索文字列の形式については、ユーザマニュアルの検索関連のドキュメントを参照してください。デフォルトでは絞り込みを行いません。
区切り文字(デフォルトは半角スペース)
整列に使用するフィールド 使用可能フィールド: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, timestamp, title, uuid デフォルト: id

calibredb add [options] file1 file2 file3 ...

指定したファイルを本としてデータベースに追加します。フォルダを指定することもできます。参照 以下のフォルダ関連のオプション。

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

追加する本の著者を設定
似たようなタイトルと著者の本が見つかった場合は、受信した形式(ファイル)を既存の本のレコードに自動的にマージします。 'ignore'の値は、重複する形式が破棄されることを意味します。 'overwrite'の値は、ライブラリ内の重複する形式が新しく追加されたファイルで上書きされることを意味します。 'new_record'の値は、重複する形式が新しいブックレコードに配置されることを意味します。
追加する本の表紙をパスで指定
本がすでにデータベースに存在する場合でも追加します。本のタイトルと著者に基づいて比較します。--automerge オプションが優先します。
空の本を追加する(形式が1つも無い本)
この本の識別子を設定します。例: -I asin:XXX -I isbn:YYY
追加する本のISBNを設定
カンマ区切りの言語のリスト(ISO639言語コードで指定するのが確実ですが、それ以外のいくつかの言語名も認識します)
追加する本のシリーズを設定
追加する本のシリーズ番号を設定
追加する本のタグを設定
追加する本のタイトルを設定

フォルダから追加

フォルダからの本の追加を制御するオプション。デフォルトでは、既知の電子書籍ファイルタイプの拡張子を持つファイルのみが追加されます。

ファイル名(glob)パターン。このパターンに一致するファイルは、既知の電子書籍ファイルタイプでなくても、フォルダーでファイルをスキャンするときに追加されます。複数のパターンに対して複数回指定できます。
ファイル名(glob)パターン。このパターンに一致するファイルは、フォルダーでファイルをスキャンするときに無視されます。複数のパターンに対して複数回指定できます。例:*。pdfはすべてのPDFファイルを無視します
フォルダ毎に一冊の本が格納され、その中のすべてのファイルはその本の別の電子書籍形式とみなす
フォルダを再帰的に処理

calibredb remove ids

idsに指定された本をデータベースから削除。idsには数字をカンマ区切りで指定します (本のIDはsearchコマンドで取得できます)。例: 23,34,57-85 (範囲で指定した場合、範囲の終端は含まれません)

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

ゴミ箱は使用しないでください

calibredb add_format [options] id ebook_file

ebook_file で指定する電子書籍ファイルを、id で指定された本の利用可能な形式として追加します。idはsearch コマンドで取得できます。形式がすでに存在する場合は、置換しないオプションを有効にした場合をのぞいて、置換されます。

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

形式がすでに存在する場合に置換しない

calibredb remove_format [options] id fmt

fmt で指定した形式を id で指定した本から削除します。id は search コマンドで取得できます。fmt はLRF, TXT, EPUB のようにファイルの拡張子で指定してください。本に指定した形式がない場合、なにもしません。

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

calibredb show_metadata [options] id

id で指定された本の、calibreのデータベースに保存された書誌を表示します。id はsearch コマンドで取得できるID番号です。

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

OPF 形式 (XML) で書誌を表示


calibredb set_metadata [options] id [/path/to/metadata.opf] id で指定された本のcalibreのデータベースに保存された書誌に

metadata.opf で指定したOPFファイルの内容を設定します。 id はsearch コマンドで取得できるID番号です。 OPF ファイルについて簡単に知りたい場合は、show_metadata コマンドの --as-opfオプションを使用してみてください。 --field オプションを使用する場合は OPFファイルを指定する必要は ありません。

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

フィールドに設定する値。field_name:value の形式で指定してください。例: --field tags:tag1,tag2。使用可能なフィールド名のリストを得るには --list-fields を使用してください。複数のフィールドの値を設定するためには、このオプションを複数指定してください。注意: 言語を指定する場合は ISO639言語コードを使用してください(英語は en、フランス語は fr 等)。識別子は以下の書式で指定してください --field identifiers:isbn:XXXX,doi:YYYYY。Boolean型(yes/no)のフィールドは、true, false またはyes, no で指定してください。
--field オプションで使用可能な書誌フィールド名のリストを表示

calibredb export [options] ids

指定した ID (カンマ区切りリスト) の本をファイルシステムにエクスポートします。 エクスポート処理では、すべての形式と表紙と書誌 (OP Fファイル)を 保存します。 ID 番号は search コマンドで取得できます。

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

IDのリストを無視してデータベースからすべての本をエクスポートします。
ファイル名の英語以外の文字をすべて英語相当の文字に calibre に変換させます。Unicode ファイル名を完全にサポートしていない古いファイルシステム上に保存するときに役に立ちます。 このスイッチ指定すると、この挙動をOFFにできます。
通常、calibreは表紙を電子書籍ファイルとは別のファイルに保存します。 このスイッチ指定すると、この挙動をOFFにできます。
通常、calibreはライブラリ内のファイルの書誌をアップデートしますが、これはディスクへの保存を遅くします。 このスイッチ指定すると、この挙動をOFFにできます。
通常、calibreは電子書籍ファイル本体に付随する別個のOPFファイルに書誌を書き込みます。 このスイッチ指定すると、この挙動をOFFにできます。
各本を保存する時のカンマ区切りの形式のリスト。デフォルトではすべての存在する形式が保存されます。
進捗状況を表示
空白をアンダースコアに置換
すべての書籍を1つのフォルダにエクスポート
保存したファイルのファイル名とフォルダ構成を制御するためのテンプレート。デフォルトは "{author_sort}/{title}/{title} - {authors}" で、タイトルと著者名をファイル名に含むフォルダに著者別に保存します。利用可能なコントロール: {author_sort, authors, id, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, tags, timestamp, title}
日付表示時の形式。 %d - 日, %b - 月(の名前), %m - 月の番号, %Y - 年. デフォルト: %b, %Y
指定したフォルダに本をエクスポートします。デフォルトは .
パスを小文字に変換

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

Export a catalog in format specified by path/to/destination extension. Options control how entries are displayed in the generated catalog output. Note that different catalog formats support different sets of options. To see the different options, specify the name of the output file and then the --help option.

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

カタログに対するカンマ区切りのデータベースID。 宣言する場合は、:option:
`
--search`は無視されます。 デフォルト: all
結果を検索文字列で絞り込みします。検索文字列の形式については、ユーザマニュアルの検索関連ドキュメントを参照してください。 デフォルト: 絞り込みなし
詳細な出力情報を表示します。デバッグに便利です。

書誌のタイトルとして使われる、生成されたカタログのタイトル。 デフォルト: 'My Books' 適用: AZW3, EPUB, MOBI出力形式
複数の著者のいる本の著者セクション用にクロスリファレンスを作成。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力形式
変換パイプラインからの別々のステージの出力を指定したフォルダに保存します。変換処理のどのステージで不具合が発生しているのか不明な場合に役立ちます。 デフォルト: 'None' 適用: AZW3, EPUB, MOBI 出力形式
ジャンルとして除外するタグを表す正規表現。 デフォルト: '[.+]|^+$' はブラケットで囲まれたタグを除外します。例: '[Project Gutenberg]''+' は本を読むデフォルトのタグ。 適用: AZW3, EPUB, MOBI出力形式
生成したカタログから除外する本を指定するルール。 除外ルールはだいたい次のいずれかのようになります。 ('<rule name>','Tags','<comma-separated list of tags>') または ('<rule name>','<custom column>','<pattern>'). 使用例: (('Archived books','#status','Archived'),) 上記例では、カスタム列 'status' の値が 'Archived' の本を除外します。 ルールが複数指定されている場合には、すべて適用されます。 デフォルト: "(('Catalogs','Tags','Catalog'),)" 適用: AZW3, EPUB, MOBI出力形式
カタログに 'Authors' セクションを含める。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力形式
カタログに 'Description' セクションを含める。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力形式
カタログに 'Genres' セクションを含める。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力形式
カタログに 'Recently Added' セクションを含める。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力形式
カタログにシリーズセクションを含める。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力形式
カタログに 'Titles' セクションを含める。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力形式
'Genre' セクション用のソースフィールド。 デフォルト: 'タグ' 適用: AZW3, EPUB, MOBI出力形式
Descriptionヘッダに挿入するノートを格納したカスタムフィールド。 デフォルト: '' 適用: AZW3, EPUB, MOBI出力形式
#<custom field>:[before|after]:[True|False] の形式で指定。 <custom field> コメントにマージするノートを含むカスタムフィールド [before|after] コメントに関するノートの位置 [True|False] ノートとコメントの間に水平線を挿入するかどうか デフォルト: '::' 適用: AZW3, EPUB, MOBI出力形式
出力プロファイルを指定。場合により、デバイスに合わせてカタログをオプティマイズする際に出力プロファイルが必要になります。例えば、'kindle' または 'kindle_dx' は、セクションと記事からなる構造化された目次を精製します。 デフォルト: 'None' 適用: AZW3, EPUB, MOBI出力形式
--prefix-rules
既読本を示すプレフィックスや、ウィッシュリスト、その他ユーザ指定のプレフィックスを含めるために使用するルールを指定。 プレフィックスルールは ('<rule name>','<source field>','<pattern>','<prefix>') のように指定します。 複数のルールが指定されている場合には、最初に一致したルールが使用されます。 デフォルト: '(('Read books','tags','+',''),('Wishlist item','tags','Wishlist','×'))' 適用: AZW3, EPUB, MOBI出力形式
GUIカタログビルだーで作成された名前つきプリセットを使用。 カタログ作成のすべての設定を指定するためのプリセットです。 デフォルト: 'None' 適用: AZW3, EPUB, MOBI出力形式
カタログ中の本の表紙のサイズのヒント (インチ指定) 範囲: 1.0 - 2.0 デフォルト: '1.0' 適用: AZW3, EPUB, MOBI出力形式
カタログ生成時に既存の表紙を上書き。 デフォルト: 'False' 適用: AZW3, EPUB, MOBI出力形式

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

データベースに格納された保存済み検索の管理。 既存の名称で検索条件を保存しようとした場合には、上書きされます。

追加の構文:

calibredb saved_searches add search_name search_expression

削除の構文:

calibredb saved_searches remove search_name

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

calibredb add_custom_column [options] label name datatype

カスタム列を作成。labelはマシン・フレンドリな列の名前。スペースやコロンを含めません。 nameは人間に読みやすい列の名前。 datatypeは以下のいずれか: bool, comments, composite, datetime, enumeration, float, int, rating, series, text

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

列のデータがどのように翻訳されるかをカスタマイズする辞書を指定するオプションです。JSON文字列で指定します。列挙型の列の場合、以下を使用してください:option:--display"{\ "enum_values\ ":[\ "val1\ ", \ "val2\ "]}" 。 値の表示方法には、様々なオプションがあります。列の型ごとのオプションは以下の通りです。 合成型: composite_template, composite_sort, make_category,contains_html, use_decorations 日付: date_format 列挙型: enum_values, enum_colors, use_decorations 整数、浮動小数点数: number_format テキスト: is_names, use_decorations 型とオプションの正しい組み合わせを知るには、GUIから適切な型のカスタム列を作成して、出力されるバックアップのOPFファイルを見てみるのが一番よい方法です(列を追加して以降にOPFが再生成されていることを確認してください)。OPFの新しい列に "display" というJSONが見つかるでしょう。
この列はタグ状のデータ(例: 複数のカンマ区切りの値)を保持します。datatypeがtextの時のみ有効です。

calibredb custom_columns [options]

利用可能なカスタム列の一覧を表示。列ラベルとIDを表示します。

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

各列の詳細を表示

calibredb remove_custom_column [options] label

labelで指定されるカスタム列を削除。 custom_columns コマンドで存在するカスタム列を見ることができます。

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

確認を表示しない

calibredb set_custom [options] column id value

idで指定された本のカスタム列の値を設定します。 search コマンドでIDのリストが取得できます。 custom_columns コマンドでカスタム列の名前のリストが取得できます。

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

もし列に複数の値を設定できる場合、値を指定した値に入れ替えるのではなく、すでにある値に付け加えます。

calibredb restore_database [options]

calibreライブラリの各ディレクトリに保存されている OPF ファイルから書誌を読み取り、データベースを復元します。 これはmetadata.dbファイルが壊れてしまった時に有用です。

注意: このコマンドを実行すると、データベースを完全に再生成します。すべての保存済み検索、ユーザカテゴリ、書誌変換ルール、書誌ごとの変換設定、カスタムレシピは失われます。復元される書誌は、OPFファイルの内容と同等となります。

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

実際にリカバリーを行います。このコマンドはこのオプションを指定しなければ実行されません。

calibredb check_library [options]

ライブラリのあるファイルシステムをチェックします。レポート:invalid_titles, extra_titles, invalid_authors, extra_authors, missing_formats, extra_formats, extra_files, missing_covers, extra_covers, failed_folders

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

CSVで出力
無視する拡張子(カンマ区切りのリスト) デフォルト: all
無視する名前のカンマ区切りのリスト デフォルト: all
カンマ区切りのレポートのリスト デフォルト: all
Vacuum the full text search database. This can be very slow and memory intensive, depending on the size of the database.

calibredb list_categories [options]

データベース中のカテゴリ情報のレポートを作成します。情報はタグブラウザに表示されるものと同等です。

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

カンマ区切りのカテゴリの検索名リスト。デフォルト: all
CSVで出力
DSVファイルのタイプ。選択肢: excel, excel-tab, unix
カテゴリ内の項目別の数ではなく、カテゴリにある項目数のみを出力します。
出力ファイル中の、1行の最大の長さ。デフォルトは画面サイズから判別。

calibredb backup_metadata [options]

データベースに格納されている書誌を、本フォルダにある個別の OPF ファイルに バックアップします。通常は自動的に行われますが、--all オプションをつけてコマンドを 実行すれば、OPF ファイルを強制的に再生成することができます。

ただし普通はこれを行う必要はありません。OPF ファイルは書誌が変更されるたびに 自動的にバックアップされるからです。

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

通常このコマンドは、古くなったOPFファイルに対してのみ実行されます。このオプションを指定すると、すべての本に対して実行されます。

calibredb clone path/to/new/library

現在のライブラリの複製を作成します。現在のライブラリと 列、仮想ライブラリ、その他の設定が同じである、新しい空の ライブラリが作成されます。

複製されたライブラリに本は含まれません。すべての本を含む複製を 作成したい場合には、単にライブラリのフォルダをコピーしてください。

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

calibredb embed_metadata [options] book_id

calibreライブラリ内に保存されている電子書籍ファイルの書誌を calibreデータベースの書誌で更新します。 通常、電子書籍ファイルの書誌の更新は、エクスポート時のみ 行われますが、このコマンドはすぐに更新を行いたい場合に便利です。 ファイル形式毎にサポートする書誌のフィールドが 異なることに留意ください。 book_id に特別な値 'all' を指定すると、すべての本が更新されます。 また、スペース区切りで複数のidを指定すること、ハイフン区切りで 範囲を指定することができます。 例: calibredb embed_metadata 1 2 10-15 23

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

指定した形式のファイルのみ書誌を更新します。複数の形式を指定する場合は、オプションを複数回指定してください。デフォルトでは、すべての形式が更新されます。

calibredb search [options] search expression

検索条件を指定してライブラリを検索し、結果を本のIDのカンマ区切りリストで返します。出力された結果は、本のIDを引数にとる他のコマンドの入力として使用するのに便利です。以下のようにcalibreの強力な検索用言語が使用できます。例: calibredb search author:asimov 'title:"i robot"'

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

返却する最大結果数。デフォルトはすべての結果。

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

Control the Full text search indexing process.

Turns on FTS indexing for this library
Turns off FTS indexing for this library
Shows the current indexing status
Can be used to re-index either particular books or the entire library. To re-index particular books specify the book ids as additional arguments after the reindex command. If no book ids are specified the entire library is re-indexed.

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

The speed of indexing. Use fast for fast indexing using all your computers resources and slow for less resource intensive indexing. Note that the speed is reset to slow after every invocation.
Wait till all books are indexed, showing indexing progress periodically

calibredb fts_search [options] search expression

Do a full text search on the entire library or a subset of it.

スペースを含む引数を calibredb に渡す場合には、クォーテーションマークでくくってください。例: "/some path/with spaces"

Only match on exact words not related words. So correction will not match correcting.
Include snippets of the text surrounding each match. Note that this makes searching much slower.
How much of the library must be indexed before searching is allowed, as a percentage. Defaults to 90
The marker used to indicate the end of a matched word inside a snippet
The marker used to indicate the start of a matched word inside a snippet
The format to output the search results in. Either "text" for plain text or "json" for JSON output.
Restrict the searched books, either using a search expression or ids. For example: ids:1,2,3 to restrict by ids or search:tag:foo to restrict to books having the tag foo.

Kovid Goyal

Kovid Goyal

9月 16, 2022 6.5.0