epub-to-pdf-cli 1.1.2 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,21 +5,30 @@
|
|
|
5
5
|
|
|
6
6
|
# 📘 EPUB to PDF CLI – Convert EPUB files to PDF using Calibre.
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
8
|
+
**epub-to-pdf-cli** is a lightweight **EPUB to PDF converter** built with **Node.js**, powered by **Calibre**.
|
|
9
|
+
|
|
10
|
+
It allows developers and automation scripts to **convert EPUB ebook files into PDF format** using a simple **command-line interface (CLI)** or a **programmatic API**.
|
|
11
|
+
|
|
12
|
+
This tool is ideal for:
|
|
13
|
+
|
|
14
|
+
- Developers
|
|
15
|
+
- Automation pipelines
|
|
16
|
+
- Ebook processing
|
|
17
|
+
- Batch EPUB to PDF conversion
|
|
10
18
|
|
|
11
19
|
---
|
|
12
20
|
|
|
13
21
|
## ✨ Features
|
|
14
22
|
|
|
15
23
|
- Convert EPUB to PDF using Calibre
|
|
16
|
-
- CLI
|
|
24
|
+
- Simple CLI (epub2pdf)
|
|
25
|
+
- Programmatic Node.js API
|
|
17
26
|
- Cross-platform (Linux, macOS, Windows)
|
|
18
|
-
-
|
|
19
|
-
-
|
|
27
|
+
- No bundled binaries (uses system Calibre)
|
|
28
|
+
- Lightweight and fast
|
|
29
|
+
- Clear error handling
|
|
20
30
|
|
|
21
31
|
---
|
|
22
|
-
|
|
23
32
|
## 📦 Installation
|
|
24
33
|
|
|
25
34
|
### Global install (CLI)
|
|
@@ -27,6 +36,7 @@ Works as both a **CLI tool** and a **Node.js library**.
|
|
|
27
36
|
```bash
|
|
28
37
|
npm install -g epub-to-pdf-cli
|
|
29
38
|
```
|
|
39
|
+
After installation, the epub2pdf command will be available globally.
|
|
30
40
|
|
|
31
41
|
## Or run without installing
|
|
32
42
|
```bash
|
|
@@ -41,6 +51,7 @@ Examples
|
|
|
41
51
|
epub2pdf mybook.epub
|
|
42
52
|
epub2pdf mybook.epub mybook.pdf
|
|
43
53
|
```
|
|
54
|
+
This converts an EPUB ebook file into a PDF document using Calibre.
|
|
44
55
|
|
|
45
56
|
## 📚 Programmatic Usage
|
|
46
57
|
### bash
|
|
@@ -53,10 +64,11 @@ import { convertEpubToPdf } from 'epub-to-pdf-cli';
|
|
|
53
64
|
|
|
54
65
|
await convertEpubToPdf('book.epub', 'book.pdf');
|
|
55
66
|
```
|
|
67
|
+
This makes the package suitable for **Node.js scripts, backend services**, and **automation workflows**.
|
|
56
68
|
|
|
57
69
|
## ⚙ Requirements
|
|
58
70
|
|
|
59
|
-
This package requires Calibre to be installed.
|
|
71
|
+
This package **requires Calibre** to be installed.
|
|
60
72
|
|
|
61
73
|
Verify installation:
|
|
62
74
|
### bash
|
|
@@ -78,11 +90,39 @@ brew install calibre
|
|
|
78
90
|
Download from: https://calibre-ebook.com/download
|
|
79
91
|
```
|
|
80
92
|
|
|
81
|
-
## ❌ Common Errors
|
|
93
|
+
## ❌ Common Errors & Solutions
|
|
82
94
|
|
|
83
95
|
ebook-convert not found
|
|
96
|
+
|
|
84
97
|
→ Install Calibre and ensure it is in PATH.
|
|
85
98
|
|
|
99
|
+
**Cause**: Calibre is not installed or not in PATH
|
|
100
|
+
|
|
101
|
+
**Solution**: Install Calibre and restart your terminal
|
|
102
|
+
|
|
103
|
+
→ Input EPUB file does not exist
|
|
104
|
+
|
|
105
|
+
**Cause**: Invalid file path
|
|
106
|
+
|
|
107
|
+
**Solution**: Check the EPUB file path and permissions
|
|
108
|
+
|
|
109
|
+
## 🔖 Versioning & Breaking Changes
|
|
110
|
+
|
|
111
|
+
This project follows **Semantic Versioning** using **Conventional Commits**.
|
|
112
|
+
|
|
113
|
+
### Commit Types
|
|
114
|
+
- `fix:` → Patch release
|
|
115
|
+
- `feat:` → Minor release
|
|
116
|
+
- `feat!:` → Major release (breaking change)
|
|
117
|
+
|
|
118
|
+
### Breaking Changes
|
|
119
|
+
Any change that breaks existing usage **must** be marked as a breaking change.
|
|
120
|
+
|
|
121
|
+
Example:
|
|
122
|
+
```bash
|
|
123
|
+
git commit -m "feat!: change CLI input format"
|
|
124
|
+
```
|
|
125
|
+
|
|
86
126
|
## 📄 License
|
|
87
127
|
|
|
88
128
|
MIT © Suraj Sutar
|