CALIBREDB(1) calibre CALIBREDB(1) NAME calibredb - calibredb calibredb command [options] [arguments] calibredb calibre calibredb calibre calibre calibre-server calibre / -> calibredb calibre 2 o --enable-local-write calibredb calibre calibre ->-> o --username --password calibre calibre-server --enable-auth --manage-users calibre ->-> --with-library URL o o list o add o o remove o add_format o remove_format o show_metadata o set_metadata o export o catalog o EPUB o saved_searches o add_custom_column o custom_columns o remove_custom_column o set_custom o restore_database o check_library o list_categories o backup_metadata o clone o embed_metadata o search o fts_index o fts_search --help, -h --library-path, --with-library calibrepathcalibrehttp://hostname:port/#library_id URL http://localhost:8080/#mylibrary library_id ID library_id - https://manual.calibre-ebook.com/ja/generated/ja/calibredb.html --password calibre ( > ) --timeout 2 --username calibre --version LIST calibredb list [options] calibre calibredb : "/some path/with spaces" --ascending --fields, -f : author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, template, timestamp, title, uuid : title,authors "all" *field_name #rating *rating --for-machine JSONJSON --limit --line-width, -w 1 --prefix --search, -s --separator ( --sort-by The field by which to sort the results. You can specify multiple fields by separating them with commas. Available fields: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, template, timestamp, title, uuid Default: id --template The template to run if "template" is in the field list. Default: None --template_file, -t Path to a file containing the template to run if "template" is in the field list. Default: None --template_heading Heading for the template column. Default: template. This option is ignored if the option --for-machine is set ADD calibredb add [options] file1 file2 file3 ... calibredb : "/some path/with spaces" --authors, -a --automerge, -m 'ignore' 'overwrite' 'new_record' --cover, -c --duplicates, -d --automerge --empty, -e 1 --identifier, -I -I asinXXX -I isbnYYY --isbn, -i ISBN --languages, -l (ISO639) --series, -s --series-index, -S --tags, -T --title, -t --add glob --ignore glob*pdfPDF --one-book-per-directory, -1 --recurse, -r REMOVE calibredb remove ids idsids (IDsearch): 23,34,57-85 () calibredb : "/some path/with spaces" --permanent ADD_FORMAT calibredb add_format [options] id ebook_file ebook_file id idsearch calibredb : "/some path/with spaces" --as-extra-data-file Add the file as an extra data file to the book, not an ebook format --dont-replace 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 calibreid search ID calibredb : "/some path/with spaces" --as-opf OPF (XML) SET_METADATA calibredb set_metadata [options] book_id [/path/to/metadata.opf] Set the metadata stored in the calibre database for the book identified by book_id from the OPF file metadata.opf. book_id is a book id number from the search command. You can get a quick feel for the OPF format by using the --as-opf switch to the show_metadata command. You can also set the metadata of individual fields with the --field option. If you use the --field option, there is no need to specify an OPF file. calibredb : "/some path/with spaces" --field, -f field_name:value : --field tags:tag1,tag2 --list-fields : ISO639( en fr ) --field identifiers:isbn:XXXX,doi:YYYYYBoolean(yes/no)true, false yes, no --list-fields, -l --field EXPORT calibredb export [options] ids Export the books specified by ids (a comma separated list) to the filesystem. The export operation saves all formats of the book, its cover and metadata (in an OPF file). Any extra data files associated with the book are also saved. You can get id numbers from the search command. calibredb : "/some path/with spaces" --all ID --dont-asciiize calibre Unicode OFF --dont-save-cover calibre OFF --dont-save-extra-files Save any data files associated with the book when saving the book OFF --dont-update-metadata calibre OFF --dont-write-opf calibreOPF OFF --formats --progress --replace-whitespace --single-dir 1 --template "{author_sort}/{title}/{title} - {authors}" : {author_sort, authors, id, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, tags, timestamp, title} --timefmt %d - , %b - (), %m - , %Y - . : %b, %Y --to-dir . --to-lowercase CATALOG 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" --ids, -i ID :option: ` --search` : all --search, -s : --verbose, -v EPUB --catalog-title : 'My Books' : AZW3, EPUB, MOBI --cross-reference-authors : 'False' : AZW3, EPUB, MOBI --debug-pipeline : 'None' : AZW3, EPUB, MOBI --exclude-genre : '[.+]|^+$' : '[Project Gutenberg]' '+' : AZW3, EPUB, MOBI --exclusion-rules ('','Tags','') ('','',''). : (('Archived books','#status','Archived'),) 'status' 'Archived' : "(('Catalogs','Tags','Catalog'),)" : AZW3, EPUB, MOBI --generate-authors 'Authors' : 'False' : AZW3, EPUB, MOBI --generate-descriptions 'Description' : 'False' : AZW3, EPUB, MOBI --generate-genres 'Genres' : 'False' : AZW3, EPUB, MOBI --generate-recently-added 'Recently Added' : 'False' : AZW3, EPUB, MOBI --generate-series : 'False' : AZW3, EPUB, MOBI --generate-titles 'Titles' : 'False' : AZW3, EPUB, MOBI --genre-source-field 'Genre' : '' : AZW3, EPUB, MOBI --header-note-source-field Description : '' : AZW3, EPUB, MOBI --merge-comments-rule #:[before|after]:[True|False] [before|after] [True|False] : '::' : AZW3, EPUB, MOBI --output-profile 'kindle' 'kindle_dx' : 'None' : AZW3, EPUB, MOBI --prefix-rules ('','','','') : '(('Read books','tags','+','\/'),('Wishlist item','tags','Wishlist','x'))' : AZW3, EPUB, MOBI --preset GUI : 'None' : AZW3, EPUB, MOBI --thumb-width () : 1.0 - 2.0 : '1.0' : AZW3, EPUB, MOBI --use-existing-cover : 'False' : AZW3, EPUB, MOBI SAVED_SEARCHES 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" 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" --display 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 GUIOPF(OPF)OPF "display" JSON --is-multiple : datatypetext CUSTOM_COLUMNS calibredb custom_columns [options] ID calibredb : "/some path/with spaces" --details, -d REMOVE_CUSTOM_COLUMN calibredb remove_custom_column [options] label label custom_columns calibredb : "/some path/with spaces" --force, -f SET_CUSTOM calibredb set_custom [options] column id value id search ID custom_columns calibredb : "/some path/with spaces" --append, -a RESTORE_DATABASE calibredb restore_database [options] calibre OPF metadata.db : OPF calibredb : "/some path/with spaces" --really-do-it, -r CHECK_LIBRARY 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, -c CSV --ignore_extensions, -e () : all --ignore_names, -n : all --report, -r : all --vacuum-fts-db LIST_CATEGORIES calibredb list_categories [options] calibredb : "/some path/with spaces" --categories, -r : all --csv, -c CSV --dialect DSV: excel, excel-tab, unix --item_count, -i --width, -w 1 BACKUP_METADATA calibredb backup_metadata [options] OPF --all OPF OPF calibredb : "/some path/with spaces" --all OPF 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" --only-formats, -f SEARCH calibredb search [options] search expression IDIDcalibre: calibredb search author:asimov 'title:"i robot"' calibredb : "/some path/with spaces" --limit, -l FTS_INDEX calibredb fts_index [options] enable/disable/status/reindex enable FTS disable FTS status reindex id reindex id calibredb : "/some path/with spaces" --indexing-speed 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-for-completion FTS_SEARCH 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" --do-not-match-on-related-words Only match on exact words not related words. So correction will not match correcting. --include-snippets Include snippets of the text surrounding each match. Note that this makes searching much slower. --indexing-threshold How much of the library must be indexed before searching is allowed, as a percentage. Defaults to 90 --match-end-marker The marker used to indicate the end of a matched word inside a snippet --match-start-marker The marker used to indicate the start of a matched word inside a snippet --output-format The format to output the search results in. Either "text" for plain text or "json" for JSON output. --restrict-to 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. AUTHOR Kovid Goyal COPYRIGHT Kovid Goyal 7.10.0 5 03, 2024 CALIBREDB(1)