epub-merge

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 11 Open GitHub ↗

Merge multiple ePUBs into one volume, or split volumes produced by epub-merge

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# EPUB Tools: epub-merge & epub-meta

This repository provides two **super fast**, lightweight command-line tools written in `bash` for working with EPUB files:

- **[epub-merge](#epub-merge)** — Merge multiple EPUB files into a single volume or extract a merged EPUB back into its original components.
- **[epub-meta](#epub-meta)** — Read, edit, and repair metadata in an EPUB or standalone OPF file.

Both tools support **EPUB 3** and **EPUB 2**, run on **macOS** and **Linux**, and require only standard POSIX utilities with minimal external libraries (`zip`, `unzip`).

## Installation

```bash
sudo curl -L https://raw.githubusercontent.com/9beach/epub-merge/refs/heads/main/epub-merge -o /usr/local/bin/epub-merge
sudo curl -L https://raw.githubusercontent.com/9beach/epub-merge/refs/heads/main/epub-meta -o /usr/local/bin/epub-meta
sudo chmod a+rx /usr/local/bin/epub-merge /usr/local/bin/epub-meta
````

## Features

### epub-merge

- Merge multiple EPUB files into one volume with a unified table of contents (TOC).
- Extract merged EPUBs back into their original component files.
- Remove duplicate fonts to reduce file size.
- Automatically detect language and apply localized volume labels (e.g., Korean: `제 1권`, `제 2권`).
- Customize titles, labels, and output filenames.
- Minimal dependencies: `zip`, `unzip`, and standard POSIX tools.

### epub-meta

- Read, modify, or remove metadata in EPUB or OPF files.
- Edit basic fields such as **title**, **author**, **language**, **publisher**, **publication date**, and **ISBN**.
- Support **multiple authors** or **subjects** separated by `//`.
- Handle **complex metadata** such as descriptions wrapped in CDATA blocks.
- Manage cover images:

- `-c FILE` — Add or set a new cover image.
  - `-C FILE` — Replace an existing cover image.
  - `-S PATH` — Extract the current cover image (extension auto-added).
  - `-f` — Automatically fix invalid cover configurations.
- Minimal dependencies: `zip`, `unzip`, and standard POSIX tools.

## How it works

### epub-merge

#### Merging EPUB Files

- Combines multiple EPUBs into one with a unified TOC organized by volume.
- Automatically generates a title based on input filenames unless overridden with `-t`.
- Applies language-specific or custom volume labels with `-l`, `-p`, `-s`, or `-v`.
- Removes duplicate fonts to minimize file size.
- Supports natural sorting of filenames (e.g., `love-8.epub`, `love-9.epub`, `love-10.epub`).
- Outputs the result to the current or specified directory (`-d`).

#### Extracting EPUB Files

- Splits a previously merged EPUB into its original components using `-x`.
- Restores metadata, TOC, and structure for each extracted EPUB.

#### Examples

```bash
# Merge all ePUB files.
epub-merge *.epub

# Add prefix and suffix to volume labels
epub-merge -p "Book " -s " Edition" part1.epub part2.epub

# Extract a merged ePUB back into original files
epub-merge -x love.epub

# Merge files in the order specified with custom volume labels
epub-merge -O -v "Love//Peace//Hate" a1.epub 02.epub 03.epub

# Merge with custom title and filename
epub-merge -t "Arabian Nights: Tales of 1,001 Nights" 1001*.epub
```

### epub-meta

#### Reading Metadata

Run without options to display current metadata:

```bash
epub-meta book.epub
```

Output example:

```
Title: Brave New World
Author: Aldous Huxley
Language: en
ISBN: 978-3-16-148410-0
Publisher: Chatto & Windus
Published: 1932-01-01
```

#### Editing Basic Metadata

Set or update common metadata fields:

```bash
# Set title and author
epub-meta -t "Brave New World Revised" -a "Aldous Huxley" book.epub

# Multiple authors or translators
epub-meta -a "Tom Waits--Waits, Tom//Lily Allen--Allen, Lily" book.epub
epub-meta -r "Deborah Smith//John Doe" book.epub

# Language, publisher, and dates
epub-meta -l ko -p "문학동네" -u "2024-08-15" book.epub

# ISBN and subject
epub-meta -i "978-89-546-1234-5" -s "Fiction//Classic" book.epub
```

#### Adding Complex Descriptions

Use CDATA for formatted or multi-line descriptions:

```bash
epub-meta -d '<![CDATA[
A dystopian novel about totalitarianism.
Published in 1949.]]>' book.epub
```

#### Managing Cover Images

```bash
# Add a new cover image
epub-meta -c cover.jpg book.epub

# Replace an existing cover
epub-meta -C new-cover.png book.epub

# Extract current cover to a file (extension auto-added)
epub-meta -S ./cover-out book.epub

# Automatically fix invalid cover configurations
epub-meta -f book.epub
```

#### Flattening TOC Depth

Promote nested EPUB2 NCX or EPUB3 NAV table-of-contents entries by one level:

```bash
# Promote depth 2 and deeper entries by one level
epub-meta -n1 book.epub

# Promote depth 3 and deeper entries by one level
epub-meta -n2 book.epub

# Collapse depth 3 and deeper entries to depth 2 with prefixed titles
epub-meta -2'•' book.epub
```

#### Removing Metadata

Remove any field by passing an empty string:

```bash
epub-meta -t "" -a "" -i "" book.epub
```

## Manuals

### epub-merge

```txt
NAME
     epub-merge -- merge multiple ePUB files into one or extract merged ePUB

SYNOPSIS
     epub-merge [-fOqV] [-d directory] [-l lang] [-p prefix] [-s suffix]
                [-t title] [-v labels] file ...
     epub-merge -x file

DESCRIPTION
     The epub-merge utility combines multiple ePUB files into a single volume
     or extracts a previously merged ePUB back into its original components.

The options are as follows:

-d directory
             Specify the output directory for generated ePUB files. The
             default is the current directory.

-f      Force overwrite of existing files with the same name.

-l lang
             Specify the language code for the merged ePUB (e.g., ko, en, ja,
             zh, ru).

-O      Disable natural sorting of input files.

-p prefix
             Add a prefix to table of contents volume labels.

-q      Quiet mode. Suppress progress messages.

-s suffix
             Add a suffix to table of contents volume labels.
             Set a custom title for the merged ePUB. This title is also used
             as the output filename.

-v labels
             Set custom table of contents volume labels for each volume.
             Labels must be separated by semicolons, for example:
             "Love//Peace//Hate".

-V      Get custom volume labels from filenames.

-x      Extraction mode. Split a merged ePUB back into its original
             component files.

EXAMPLES
     Merge three ePUB files with natural sorting (default). Files are merged
     in natural sort order (love-8, love-9, love-10) regardless of the input
     order:

epub-merge love-10.epub love-8.epub love-9.epub

Merge files in the order specified with custom volume labels:

epub-merge -O -v "Love//Peace//Hate" a1.epub 02.epub 03.epub

Files are processed in the exact order specified (not naturally sorted),
     with table of contents labels "Love", "Peace", and "Hate" for each
     volume respectively.

Extract a merged ePUB back into original files:

epub-merge -x love.epub

Merge with custom title and filename:

epub-merge -t "Arabian Nights: Tales of 1,001 Nights" 1001*.epub
```

### epub-meta

```
NAME
     epub-meta -- read and edit metadata in an ePUB or OPF file

SYNOPSIS
     epub-meta [-fOq] [-a author] [-c file] [-C file] [-d description]
               [-i isbn] [-l lang] [-m date] [-n level] [-p publisher]
               [-r translator] [-s subject] [-S path] [-t title]
               [-u date] [-x rights] [-2 prefix]
               {epub-file | opf-file}

DESCRIPTION
     The epub-meta utility reads and modifies metadata in ePUB files or OPF
     (Open Packaging Format) files. When invoked without options, it displays
     the current metadata. With options, it updates the specified metadata
     fields.

The options are as follows:

-a author
             Set the author(s) of the ePUB. Multiple authors can be specified
             by separating them with "//". Each author can optionally include
             a sort name using the format "Name--Sort Name". For example:
             "Bob Marley//Tom Waits--Waits, Tom". Use an empty string ("") to
             remove all authors.

-c file
             Set a new cover image from the specified file. This adds a cover
             image.

-C file
             Replace the existing cover image with the image from the
             specified file.

-d description
             Set the description (summary) of the ePUB. Use an empty string
             ("") to remove the description.

-f      Auto-fix cover image configuration. Automatically repairs common
             issues with cover image metadata and references.

-i isbn
             Set the ISBN (International Standard Book Number). Use an empty
             string ("") to remove the ISBN.

-l lang
             Set the language code for the ePUB (e.g., en for English, ko for
             Korean, ja for Japanese, zh for Chinese).

-m date
             Set the modification date.

-n level
             Flatten table-of-contents depth in EPUB NCX and NAV files.
             Level 1 promotes depth 2 and deeper entries by one level.
             Level 2 promotes depth 3 and deeper entries by one level.
             The original TOC file is stored in the EPUB with a timestamped
             "-original" suffix.

-2 prefix
             Collapse depth 3 and deeper table-of-contents entries to depth
             2 in EPUB NCX and NAV files, prefixing each collapsed title.
             Depth 3 gets the prefix once, depth 4 twice, and so on, followed
             by a space before the original title.

-O      Do not sort attributes when displaying metadata.

-p publisher
             Set the publisher name. Use an empty string ("") to remove the
             publisher.

-q      Quiet mode. Suppress progress messages.

-r translator
             Set the translator(s). Uses the same format as the -a option,
             with multiple translators separated by "//" and optional sort
             names using "Name--Sort Name" format.

-s subject
             Set the subject(s) or categories. Multiple subjects can be
             specified by separating them with "//". Use an empty string ("")
             to remove all subjects.

-S path
             Extract the cover image to the specified path. The appropriate
             file extension will be added automatically based on the image
             format.

-t title
             Set the title of the ePUB. Use an empty string ("") to remove
             the title.

-u date
             Set the publication date in ISO 8601 format (e.g., "2016-07-31").

-x rights
             Set the rights or copyright information. Use an empty string ("")
             to remove rights information.

-1      Display each attribute value in a single line (replace newlines 
             with \n)

EXAMPLES
     Display current metadata:

epub-meta book.epub

Set title and author:

epub-meta -t "1984" -a "George Orwell--Orwell, George" book.epub

Set multiple authors:

epub-meta -a "Neil Gaiman--Gaiman, Neil//Terry Pratchett" book.epub

Update language and publisher:

epub-meta -l en -p "Penguin Books" book.epub

Set publication date and ISBN:

epub-meta -u "2024-03-15" -i "978-0-123456-78-9" book.epub

Auto-fix cover image in quiet mode:

epub-meta -fq book.epub

Promote depth 2 and deeper TOC entries by one level:

epub-meta -n1 book.epub

Collapse depth 3 and deeper TOC entries to depth 2 with bullets:

epub-meta -2'•' book.epub

Add cover image:

epub-meta -c cover.jpg book.epub

Extract cover image:

epub-meta -S cover-output book.epub

Update description with CDATA-wrapped HTML:

epub-meta -d '<![CDATA[
 A dystopian novel about totalitarianism.
 Published in 1949.]]>' book.epub

Remove description:

epub-meta -d "" book.epub

Set multiple subjects:

epub-meta -s "Fiction//Science Fiction//Dystopian" book.epub
```

epub-merge

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

epub-merge

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README