CALIBREDB(1) calibre CALIBREDB(1) NAME calibredb - calibredb calibredb command [options] [arguments] calibredb calibre calibredb calibre calibre calibre"" calibre ""calibre-server` calibre "/ -> "`calibredb calibre o --enable-local-write calibredb calibre calibre "->->" o --username --passwordcalibredb calibre-server --enable-auth --manage-users calibre "->->/" URL --with-library 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 calibre calibre URLhttp://hostname:port/#library_idhttp://localhost:8080/#mylibrarylibrary_ididlibrary_id - idhttps://manual.calibre-ebook.com/generated/en/calibredb.html --password calibre > --timeout calibre --username --version LIST calibredb list [options] calibre %p: "/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 JSON --limit --line-width, -w --prefix --search, -s --separator --sort-by author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, template, timestamp, title, uuid id --template "template" calibre --template_file, -t "template" --template_heading template. :option:--for-machine ADD calibredb add [] file1 file2 file3 ... %p: "/some path/with spaces" --authors, -a --automerge, -m ()"Ignore""overwrite""new_record" --cover, -c --duplicates, -d :option: ` --automerge` --empty, -e () --identifier, -I -I asin:XXX -I isbn:YYY --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 idid id id 23,34,57-85 %p: "/some path/with spaces" --permanent ADD_FORMAT calibredb add_format [options] id ebook_file ebook_fileidid %p: "/some path/with spaces" --as-extra-data-file --dont-replace REMOVE_FORMAT calibredb remove_format [options] id fmt ID- fmtidfmt LRFTXTEPUB fmt %p: "/some path/with spaces" SHOW_METADATA calibredb show_metadata [options] id calibre id idid %p: "/some path/with spaces" --as-opf OPF(XML) SET_METADATA calibredb set_metadata [options] book_id [/path/to/metadata.opf] OPF --metadata.opf calibre book_id book_id id --as-opf show_metadata OPF --field --field OPF %p: "/some path/with spaces" --field, -f field_name:value--field tags:tag1,tag2:option:--list-fields`ISO639enfr:option:--field` identifiers:isbn:XXXX,doi:YYYYY(/)true false yes no --list-fields, -l --field EXPORT calibredb export [options] ids id() ( opf) id %p: "/some path/with spaces" --all id --dont-asciiize calibreUnicode --dont-save-cover calibre --dont-save-extra-files --dont-update-metadata calibrecalibre --dont-write-opf calibre OPF --formats --progress --replace-whitespace --single-dir --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] path/to/destination extension --help %p: "/some path/with spaces" --ids, -i ID --search all --search, -s no filtering --verbose, -v EPUB --catalog-title 'My Books' AZW3ePubMOBI --cross-reference-authors : 'False' : AZW3, EPUB, MOBI --debug-pipeline : 'None' : AZW3, EPUB, MOBI --exclude-genre '[.+]|^+$' '[Project Gutenberg]', '+', AZW3, EPUB, MOBI --exclusion-rules ('','','') ('','','') (('','#status'',''),) "status'""" : "(('Catalogs','Tags','Catalog'),)" AZW3, EPUB, MOBI --generate-authors "" 'False' AZW3, EPUB, MOBI --generate-descriptions "" 'False' AZW3, EPUB, MOBI --generate-genres "" 'False' AZW3, EPUB, MOBI --generate-recently-added "" 'False' AZW3, EPUB, MOBI --generate-series "" 'False' AZW3, EPUB, MOBI --generate-titles "" 'False' AZW3, EPUB, MOBI --genre-source-field "" '' AZW3, EPUB, MOBI --header-note-source-field : '' : AZW3, EPUB, MOBI --merge-comments-rule #:[before|after]:[True|False] : [before|after] [True|False] - : '::' : AZW3, EPUB, MOBI --output-profile '''kindle' 'kindle_dx' 'None' AZW3EPUBMOBI --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 %p: "/some path/with spaces" ADD_CUSTOM_COLUMN calibredb add_custom_column [options] label name datatype bool, comments, composite, datetime, enumeration, float, int, rating, series, text %p: "/some path/with spaces" --display JSON --display"{\ "enum_values\ ":[\ "val1\ ", \ "val2\ "]}" 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 OPF OPF OPF JSON "" --is-multiple () CUSTOM_COLUMNS calibredb custom_columns [options] id %p: "/some path/with spaces" --details, -d REMOVE_CUSTOM_COLUMN calibredb remove_custom_column [options] label custom_columns command %p: "/some path/with spaces" --force, -f SET_CUSTOM calibredb set_custom [options] column id value id id custom_columns %p: "/some path/with spaces" --append, -a RESTORE_DATABASE calibredb restore_database [options] calibreOPFmetadata.db OPF %p: "/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 %p: "/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] %p: "/some path/with spaces" --categories, -r --csv, -c CSV --dialect CSVexcel, excel-tab, unix --item_count, -i () --width, -w BACKUP_METADATA calibredb backup_metadata [options] OPF OPF --all OPF %p: "/some path/with spaces" --all OPF CLONE calibredb clone path/to/new/library %p: "/some path/with spaces" EMBED_METADATA calibredb embed_metadata [options] book_id calibre calibre calibre book_id "all"id IDcalibredb embed_metadata 1 2 10-15 23 %p: "/some path/with spaces" --only-formats, -f SEARCH calibredb search [options] search expression idid calibrecalibredb searchauthor:asimov 'title:"i robot"' %p: "/some path/with spaces" --limit, -l FTS_INDEX calibredb fts_index [options] enable/disable/status/reindex enable disable status reindex reindexid id %p: "/some path/with spaces" --indexing-speed fastslowslow --wait-for-completion FTS_SEARCH calibredb fts_search [options] search expression %p: "/some path/with spaces" --do-not-match-on-related-words correctionorrecting --include-snippets --indexing-threshold 90 --match-end-marker --match-start-marker --output-format "text"JSON"json" --restrict-to idids:1,2,3idsearch:tag:foofoo AUTHOR Kovid Goyal COPYRIGHT Kovid Goyal 8.7.0 18, 2025 CALIBREDB(1)