NAME¶

calibredb - calibredb

calibredb command [options] [arguments]

calibredb は calibreデータベース用のコマンドラインインタフェースです。これにはいくつかのサブコマンドがあり、それらについては以下で説明します。

calibredb を使用すると、パスで指定された calibreデータベース、またはローカルマシンやインターネット上で動作している calibre の コンテンツサーバ を操作できます。calibre の コンテンツサーバ は、calibre-server プログラムを使用するか、calibre のメインプログラムで 接続/共有  →  コンテンツサーバを起動 をクリックすることで起動できます。calibredb は calibre ライブラリを変更できるため、事前にサーバー側で認証を設定する必要があります。その方法には以下の2通りがあります。

グローバルオプション¶

LIST¶

calibredb list [options]

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

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

ADD¶

calibredb add [options] file1 file2 file3 ...

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

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

REMOVE¶

calibredb remove ids

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

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

ADD_FORMAT¶

calibredb add_format [options] id ebook_file

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

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

REMOVE_FORMAT¶

calibredb remove_format [options] id fmt

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

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

SHOW_METADATA¶

calibredb show_metadata [options] id

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

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

SET_METADATA¶

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

calibreデータベースに保存されている、指定された本の書誌データを、OPFファイルmetadata.opfから取得します。book_idは、searchコマンドで取得した本のIDです。 show_metadataコマンドに--as-opfオプションを使用すると、OPFフォーマットの概要を簡単に確認できます。 --fieldオプションを使用すると、個々のフィールドのメタデータを設定することもできます。--fieldオプションを使用する場合は、OPFファイルを指定する必要はありません。

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

EXPORT¶

calibredb export [options] ids

ids（カンマ区切りのリスト）で指定された本をファイルシステムにエクスポートします。 エクスポート操作では、本のすべてのフォーマット、表紙、メタデータ（OPFファイル）が保存されます。本に関連付けられた追加データファイルもすべて保存されます。 ID番号は、検索コマンドで取得できます。

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

CATALOG¶

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

path/to/destination の拡張子で指定される形式でカタログをエクスポートします。 出力されたカタログに表示するエントリはoptionsで制御します。 カタログの形式により、サポートするオプションが異なるので注意してください。 異なったオプションを見るには、出力ファイルの名前と、次に--help オプションを指定してください。

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

SAVED_SEARCHES¶

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

このデータベースに保存されている保存済み検索を管理します。 すでに存在する名前でクエリを追加しようとすると、置き換えられます。

一覧表示 (既定のアクション) の構文:

calibredb saved_searches list

追加の構文:

calibredb saved_searches add search_name search_expression

削除の構文:

calibredb saved_searches remove search_name

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

ADD_CUSTOM_COLUMN¶

calibredb add_custom_column [options] label name datatype

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

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

CUSTOM_COLUMNS¶

calibredb custom_columns [options]

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

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

REMOVE_CUSTOM_COLUMN¶

calibredb remove_custom_column [options] label

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

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

SET_CUSTOM¶

calibredb set_custom [options] column id value

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

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

RESTORE_DATABASE¶

calibredb restore_database [options]

calibreライブラリの各フォルダにあるOPFファイルに保存されているメタデータから、このデータベースを復元します。これは、metadata.dbファイルが破損してしまった場合に役立ちます。

警告: このコマンドを実行すると、データベースが完全に再生成されます。 保存済みの検索、ユーザーカテゴリ、プラグボード、本ごとの変換設定、およびカスタムレシピがすべて失われます。復元されたメタデータの正確さは、OPFファイルに含まれる情報に依存します。

復元が成功した場合は終了ステータスが0、完全に失敗した場合は1、 データベースは復元されたものの、一部の本やその他のデータを復元できなかった場合は2となります。

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

CHECK_LIBRARY¶

calibredb check_library [options]

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

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

LIST_CATEGORIES¶

calibredb list_categories [options]

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

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

BACKUP_METADATA¶

calibredb backup_metadata [options]

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

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

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

CLONE¶

calibredb clone path/to/new/library

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

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

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

EMBED_METADATA¶

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"

SEARCH¶

calibredb search [options] search expression

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

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

FTS_INDEX¶

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

全文検索用インデックス生成処理の設定

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

FTS_SEARCH¶

calibredb fts_search [options] search expression

ライブラリ全体またはその一部に対して全文検索を実行します。

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

NOTES¶

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

著者、シリーズ、タグ、発行者などの項目に付けられたノートを管理します。FIELD はフィールドのルックアップ名で、例えば authors、series、tags、publisher、#mycolumn などです。ITEM は項目の名前で、例えば著者の名前です。項目は大文字と小文字を区別せずに照合されます。

ノートがある項目を一覧表示します。指定したフィールドの項目だけに絞ることもできます。これが既定のアクションです:

calibredb notes list [FIELD]

calibre の「ノートをブラウズ」ツールと同じ SQLite 全文検索の構文を使用して、ノートのテキストを検索します。一致したそれぞれについて、フィールド、項目名、抜粋を表示します。特定のフィールドのノートだけを検索するには --field を使用します:

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

項目のノートを Markdown 形式のテキストで表示します。--as-html を指定すると、画像を埋め込んだ HTML 文書として表示し、そのまま set で使用できます:

calibredb notes show FIELD ITEM

項目のノートを HTML ファイルの内容で置き換えます。標準入力から HTML を読み込むには - を使用します。base64 でエンコードされた data: URL として埋め込まれた画像は、ローカルとリモートのどちらのライブラリでもノートに追加されます。ローカルライブラリを使用してファイルから読み込む場合は、ファイルからの相対パスで参照されている画像も追加されます:

calibredb notes set FIELD ITEM FILE

項目のノートを削除します:

calibredb notes remove FIELD ITEM

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

ITEMS¶

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

すべての本に含まれる著者名、タグ、シリーズ、発行者などの項目を、名前変更または削除します。これは、calibreインタフェースにおける「著者名、タグなどの管理」操作と同様の機能です。FIELDには、対象となるフィールドの識別名（例: authors、tags、series、publisher、または #mycolumn）を指定します。項目の照合は、大文字と小文字を区別せずに行われます。

項目名を変更します。変更後の名前（NEW_NAME）がすでに存在する場合、その2つの項目は統合されます。複数の値を持つフィールドの場合、NEW_NAMEに複数の値を指定することも可能です。その際は、各フィールドで定められた区切り文字（タグの場合はカンマなど）で値を区切ります。指定した項目は、それらのすべての値に置き換えられます。

calibredb items rename FIELD ITEM NEW_NAME

すべての本から1つ以上の項目を削除します。著者名 は削除できません。

calibredb items remove FIELD ITEM [ITEM ...]

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

VIRTUAL_LIBRARIES¶

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

このライブラリの仮想ライブラリを管理します。仮想ライブラリとは、ライブラリにそれに一致する本だけが含まれているかのように動作する検索です。仮想ライブラリ内の本を一覧表示または検索するには、calibredb search 'vl:"name"' を使用します。

仮想ライブラリを、その検索と本の数とともに一覧表示します。これが既定のアクションです:

calibredb virtual_libraries list

検索から仮想ライブラリを作成します:

calibredb virtual_libraries add name search_expression

仮想ライブラリの名前を変更します:

calibredb virtual_libraries rename name new_name

仮想ライブラリを削除します。その中の本は変更されません:

calibredb virtual_libraries remove name ...

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

ANNOTATIONS¶

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

本の注釈 (calibre 電子書籍ビューアで作成された、または他のアプリケーションから同期されたハイライトとブックマーク) を管理します。

注釈をIDとともに一覧表示します。これが既定のアクションです:

calibredb annotations list

「注釈を見る」ツールと同じ SQLite 全文検索の構文を使用して、ハイライトされたテキスト、注釈のメモ、ブックマークのタイトルを検索します。結果は関連度順に並べられ、注釈のID、本のタイトル、一致した抜粋が含まれます。本を絞り込むには --search、注釈の種類を絞り込むには --type、ユーザーを絞り込むには --user-type と --annotation-user、語形どおりに一致させるには --no-stemming を使用します。--format json を指定すると、注釈データと抜粋を含む結果を JSON 配列で出力します:

calibredb annotations search "search expression"

注釈を本ごとにまとめて、プレーンテキスト、Markdown、JSON のいずれかでエクスポートします。JSON は「注釈を見る」ツールのエクスポートボタンで作成されるものと同じ calibre の注釈コレクションです:

calibredb annotations export

このコマンドまたは「注釈を見る」ツールで JSON としてエクスポートされた calibre の注釈コレクションをインポートします。コレクションには1冊の本の注釈だけが含まれている必要があります。BOOK_ID はインポート先の本のIDで、ファイルに保存されているIDではありません。FORMAT 形式の注釈だけがインポートされ、他の形式の注釈はスキップされます。FORMAT はインポート先の本に存在している必要があります。位置が一致するように、同じ版の本を使用してください:

calibredb annotations import BOOK_ID FORMAT FILE

FILE に - を指定すると標準入力から読み込みます。インポートの前にコレクション全体が検証されます。注釈はビューアと同じ規則で既存の注釈と統合されます。ハイライトは UUID で、ブックマークはタイトルで照合され、タイムスタンプが新しいほうが優先されます。繰り返しインポートしても重複は作成されません。関係のない注釈と読書位置は保持されます。

既定では、注釈は calibre 電子書籍ビューアの注釈としてインポートされます。代わりにコンテンツサーバーのユーザーの注釈としてインポートするには、--user-type web --annotation-user USER を使用します。エクスポートされたコレクションには注釈が属するユーザーが記録されており、複数のユーザーの注釈を含むコレクションは拒否されます。1人のユーザーの注釈をエクスポートするには、エクスポート時に --user-type と --annotation-user オプションを使用してください。

指定したID (list で表示されるもの) の注釈を完全に削除します:

calibredb annotations remove ID ...

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

TRASH¶

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

削除されてゴミ箱に入れられた本と形式を管理します。 ゴミ箱のエントリは、数日後に自動的に完全に削除されます。 ids は remove コマンドと同様に、本のIDをカンマ区切りで指定したものです。例: 23,34,57-85 (範囲で指定した場合、範囲の終端は含まれません)。

削除された本と形式を、削除日時 (ローカル時刻) とともに、最近削除されたものから順に一覧表示します。すでに存在しない本の削除された形式は復元不可として表示され、削除することしかできません。--for-machine を指定すると、日時は UTC になります:

calibredb trash list

削除された本を復元します。--formats を指定すると、本の削除された形式を復元します:

calibredb trash restore ids

ゴミ箱からエントリを完全に削除します:

calibredb trash delete ids

ゴミ箱の中身をすべて完全に削除します:

calibredb trash empty

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

DATA_FILES¶

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

ローカルまたはリモートのライブラリで、本に関連付けられた追加のデータファイルを管理します。 名前は本のデータディレクトリからの相対パスです。サブディレクトリには / を使用します (も使用できます)。名前に を含むファイルは一覧には表示されますが、それ以外の操作はできません。 電子書籍の形式、表紙、metadata.opf にはこのコマンドではアクセスできません。 リモートライブラリでは、他の管理コマンドと同様に書き込み権限のあるアカウントが必要です。また、ライブラリごとの検索制限があるアカウントはサポートされていません。

ファイル名、サイズ (バイト)、更新日時 (Unix エポックからの秒数) を一覧表示します。JSON で出力するには --for-machine を使用します:

calibredb data_files list BOOK_ID

ファイルをそのベース名で追加します。名前やサブディレクトリを指定するには --name を使用します。--replace を指定しない限り、既存のファイルは置き換えられません。これは add_format --as-extra-data-file でも行えます:

calibredb data_files add BOOK_ID FILE

データファイルを1つ、ローカルマシンの --output に保存します。--replace を指定しない限り、既存の出力ファイルは置き換えられません:

calibredb data_files get BOOK_ID NAME --output FILE

ファイルの名前を変更します。--replace を指定しない限り、既存の変更先は置き換えられません:

calibredb data_files rename BOOK_ID NAME NEW_NAME

ファイルをオペレーティングシステムのゴミ箱に移動します。--permanent を指定すると、代わりに完全に削除します。リモートライブラリの場合、これはサーバー上で行われます:

calibredb data_files remove BOOK_ID NAME

rename と remove によって空になったディレクトリは削除されます。リモートライブラリでは各ファイルが1回のリクエストで転送されるため、非常に大きなファイルにはクライアントとサーバーの両方に十分なメモリが必要です。また、アップロードはサーバーの最大リクエストサイズによって制限されます。

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

Author¶

Kovid Goyal

Copyright¶

Kovid Goyal