Kepubify

https://pgaskin.net/kepubify/docs/
Admin
Kepubify is a fast command-line tool that converts EPUBs to Kobo's enhanced KEPUB format, enabling...
Tokens:3,544
Snippets:33
Trust Score:8.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Getting Started with Kepubify

Source: https://pgaskin.net/kepubify/docs

Instructions for downloading and running Kepubify on Windows, macOS, Linux, and FreeBSD, as well as building from source.

```APIDOC
## Getting Started with Kepubify

### Windows
  1. Download `kepubify-windows-32bit.exe` or `kepubify-windows-64bit.exe` from the releases page. If you're unsure which one to choose, use `kepubify-windows-32bit.exe`.
  2. Drag your books or folder of books onto the downloaded executable. The converted files will be in the current directory with the suffix `_converted`.

### macOS
  1. Download `kepubify-darwin-64bit` from the releases page. If you have a M1 chip, download `kepubify-darwin-arm64` instead. You can also install kepubify with Homebrew.
  2. Type `chmod +x ` into the terminal (note the space at the end), drag the file you downloaded onto it (or type the path manually), and press enter.
  3. Drag the file you downloaded onto the terminal again, then drag the folders or files onto it (or type them manually), pressing space before each one, then press enter. The converted files will be in your home folder with the suffix `_converted`.

### Linux
  1. Download the kepubify binary for your architecture from the releases page.
  2. `chmod +x` the binary.
  3. Run the binary with one or more files/directories to convert as arguments. The converted files will be in the current directory with the suffix `_converted`.

### FreeBSD
  1. Install kepubify with `pkg install kepubify`.
  2. Run kepubify with one or more files/directories to convert as arguments. The converted files will be in the current directory with the suffix `_converted`.

### Building from source / other
  1. Install Go 1.16 or later if you haven't already done so.
  2. Run `go install github.com/pgaskin/kepubify/v4/cmd/kepubify@latest`. The resulting binary will be in `$HOME/go/bin`, or whatever `GOBIN` is set to. If you are using Go 1.16, I also recommend adding ` -tags zip117` after `go build` for better performance.
```

--------------------------------

### Install Kepubify with Go

Source: https://pgaskin.net/kepubify/docs

Install kepubify using Go. Ensure you have Go 1.16 or later installed. For Go 1.16, consider adding '-tags zip117' for performance.

```bash
go install github.com/pgaskin/kepubify/v4/cmd/kepubify@latest
```

--------------------------------

### Install Kepubify on FreeBSD

Source: https://pgaskin.net/kepubify/docs

Install kepubify using the pkg package manager on FreeBSD.

```bash
pkg install kepubify
```

--------------------------------

### Basic Kepubify Usage

Source: https://pgaskin.net/kepubify/docs

Convert EPUB files to Kobo EPUBs. Drag books or folders onto the executable or run from the command line.

```bash
Usage: kepubify [options] input_path [input_path]...
```

--------------------------------

### Run seriesmeta command-line tool

Source: https://pgaskin.net/kepubify/docs

Displays the command-line options and arguments for the seriesmeta utility.

```text
Usage: seriesmeta [options] [kobo_path]

Options:
  -h, --help         Show this help message
  -p, --no-persist   Don't ensure metadata is always set (this will cause series metadata to be lost if opening a book after an import but before a reboot)
  -n, --no-replace   Don't replace existing series metadata (you probably don't want this option)
  -u, --uninstall    Uninstall seriesmeta table and hooks (imported series metadata will be left untouched)

Arguments:
  kobo_path is the path to the Kobo eReader. If not specified, seriesmeta will try to automatically detect the Kobo.
```

--------------------------------

### Run covergen command-line tool

Source: https://pgaskin.net/kepubify/docs

Displays the command-line options and arguments for the covergen utility.

```text
Usage: covergen [options] [kobo_path]

Options:
  -a, --aspect-ratio float   Stretch the covers to fit a specific aspect ratio (for example 1.3, 1.5, 1.6)
  -g, --grayscale            Convert images to grayscale
  -h, --help                 Show this help message
  -i, --invert               Invert images
  -m, --method string        Resize algorithm to use (bilinear, bicubic, lanczos2, lanczos3) (default "lanczos3")
  -r, --regenerate           Re-generate all covers

Arguments:
  kobo_path is the path to the Kobo eReader. If not specified, covergen will try to automatically detect the Kobo.
```

--------------------------------

### Kepubify Output Options

Source: https://pgaskin.net/kepubify/docs

Manage output files and directories, including updating existing conversions and preserving directory structures.

```bash
-u, --update             Don't reconvert files which have already been converted (i.e. don't overwrite output files)
  -i, --inplace            Don't add the _converted suffix to converted files and directories
      --no-preserve-dirs   Flatten the directory structure of the input (an error will be shown if there are conflicts)
  -o, --output string      [>1 inputs || 1 file input with existing dir output]: Directory to place converted files/dirs under; [1 file input with
                           nonexistent output]: Output filename; [1 dir input]: Output directory for contents of input (default: current directory)
      --calibre            Use .kepub instead of .kepub.epub as the output extension (for Calibre compatibility, only use if you know what you are doing)
  -x, --copy strings       Copy files with the specified extension (with a leading period) to the output unchanged (no effect if the filename ends up the same)
```

--------------------------------

### Make Kepubify Executable on macOS/Linux

Source: https://pgaskin.net/kepubify/docs

Make the downloaded kepubify binary executable using chmod.

```bash
chmod +x 
```

--------------------------------

### Convert EPUB files using Kepubify CLI

Source: https://pgaskin.net/kepubify/docs

Basic and advanced command-line usage for converting single books or entire directories.

```bash
kepubify /path/to/the/book.epub
```

```bash
kepubify --output "/path/to/save/the/book/" /path/to/the/book.epub
```

```bash
kepubify -o "converted" *.epub
```

```bash
kepubify /path/to/the/books/
```

```bash
kepubify -o "/path/to/output/the/converted/books" /path/to/the/books/
```

```bash
kepubify --update /path/to/the/books/
```

```bash
kepubify --update --inplace --calibre /path/to/calibre/library/
```

```bash
kepubify --output /path/to/kobo/kepubify --update --copy .pdf /path/to/books/
```

--------------------------------

### Kepubify Usage and Options

Source: https://pgaskin.net/kepubify/docs

Details on how to use the kepubify command-line tool, including general, output, and conversion options.

```APIDOC
## Kepubify Usage

Kepubify converts EPUBs to Kobo EPUBs.

### Usage
```
Usage: kepubify [options] input_path [input_path]...

General Options:
  -v, --verbose   Show extra information in output
      --version   Show the version
  -h, --help      Show this help text

Output Options:
  -u, --update             Don't reconvert files which have already been converted (i.e. don't overwrite output files)
  -i, --inplace            Don't add the _converted suffix to converted files and directories
      --no-preserve-dirs   Flatten the directory structure of the input (an error will be shown if there are conflicts)
  -o, --output string      [>1 inputs || 1 file input with existing dir output]: Directory to place converted files/dirs under; [1 file input with
                           nonexistent output]: Output filename; [1 dir input]: Output directory for contents of input (default: current directory)
      --calibre            Use .kepub instead of .kepub.epub as the output extension (for Calibre compatibility, only use if you know what you are doing)
  -x, --copy strings       Copy files with the specified extension (with a leading period) to the output unchanged (no effect if the filename ends up the same)

Conversion Options:
      --smarten-punctuation        Smarten punctuation (smart quotes, dashes, etc) (excluding pre and code tags)
  -c, --css stringArray            Custom CSS to add to ebook
      --hyphenate                  Force enable hyphenation
      --no-hyphenate               Force disable hyphenation
      --fullscreen-reading-fixes   Enable fullscreen reading bugfixes based on https://www.mobileread.com/forums/showpost.php?p=3113460&postcount=16
  -r, --replace stringArray        Find and replace on all html files (repeat any number of times) (format: find|replace)
      --charset string             Override the HTML charset (use "auto" to detect it from the content) (default "utf-8")
```
```

--------------------------------

### Kepubify General Options

Source: https://pgaskin.net/kepubify/docs

Control verbosity, display version, or show help text for Kepubify.

```bash
-v, --verbose   Show extra information in output
      --version   Show the version
  -h, --help      Show this help text
```

--------------------------------

### Kepubify Conversion Options

Source: https://pgaskin.net/kepubify/docs

Configure conversion settings such as smart punctuation, custom CSS, hyphenation, and character encoding.

```bash
--smarten-punctuation        Smarten punctuation (smart quotes, dashes, etc) (excluding pre and code tags)
  -c, --css stringArray            Custom CSS to add to ebook
      --hyphenate                  Force enable hyphenation
      --no-hyphenate               Force disable hyphenation
      --fullscreen-reading-fixes   Enable fullscreen reading bugfixes based on https://www.mobileread.com/forums/showpost.php?p=3113460&postcount=16
  -r, --replace stringArray        Find and replace on all html files (repeat any number of times) (format: find|replace)
      --charset string             Override the HTML charset (use "auto" to detect it from the content) (default "utf-8")
```

--------------------------------

### Convert Calibre library on Windows

Source: https://pgaskin.net/kepubify/docs

PowerShell commands to convert an existing Calibre library in-place and update the database.

```powershell
$library = "C:\path\to\Calibre Library\"
```

```powershell
C:\path\to\kepubify.exe --calibre --update --inplace "$library"
```

```powershell
dir -Path "$library" -Filter *.kepub -Recurse | %{calibredb add -m 'ignore' $_.FullName}
```

--------------------------------

### Fix permission denied errors

Source: https://pgaskin.net/kepubify/docs

Command to grant execution permissions to the kepubify binary on Unix-like systems.

```bash
chmod +x /path/to/kepubify
```

--------------------------------

### Convert Calibre library on Linux/macOS

Source: https://pgaskin.net/kepubify/docs

Terminal commands to convert an existing Calibre library in-place and update the database.

```bash
LIBRARY="/path/to/Calibre Library"
```

```bash
kepubify --calibre --update --inplace "$library"
```

```bash
find "$LIBRARY" -name '*.kepub' | xargs -I _ calibredb add -m 'ignore' _
```
Tokens:
Raw