https://github.com/jurczewski/private-pdf-converter
Private PDF Converter is a simple, secure offline tool for quickly turning your image files (like PNGs) into a single PDF - no internet required. Your files stay private on your device.
https://github.com/jurczewski/private-pdf-converter
100commitow 100commits cli dotnet dotnet-tool merge-pdf merge-pdf-images pdf pdf-converter privacy privacy-protection private split-pdf tool
Last synced: 26 days ago
JSON representation
Private PDF Converter is a simple, secure offline tool for quickly turning your image files (like PNGs) into a single PDF - no internet required. Your files stay private on your device.
- Host: GitHub
- URL: https://github.com/jurczewski/private-pdf-converter
- Owner: jurczewski
- License: mit
- Created: 2024-02-17T11:19:21.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2026-01-04T22:05:06.000Z (about 1 month ago)
- Last Synced: 2026-01-14T07:35:01.870Z (30 days ago)
- Topics: 100commitow, 100commits, cli, dotnet, dotnet-tool, merge-pdf, merge-pdf-images, pdf, pdf-converter, privacy, privacy-protection, private, split-pdf, tool
- Language: C#
- Homepage:
- Size: 186 KB
- Stars: 20
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 🔎 PrivatePdfConverter
[](https://100commitow.pl/)
[](https://github.com/jurczewski/private-pdf-converter/actions/workflows/build.yaml)
[](https://www.nuget.org/packages/PrivatePdfConverter/)
[](https://opensource.org/licenses/MIT)
[](https://www.linkedin.com/in/jurczewski/)
[](https://www.buymeacoffee.com/jurczewski)
###### ⭐ - The star motivates me a lot
---
## ✒️ Description
Private PDF Converter is a secure, offline tool that quickly converts image files (like PNGs) into PDFs without needing an internet connection - keeping your data private on your device.
It supports converting single images or entire directories into single PDF files. You can also merge multiple PDFs from a folder into one file, add password encryption for security, and watermark PDFs with a logo image adjustable by size, position, and opacity. The terminal interface is simple and efficient, making complex tasks easy to handle with just a single command.
Check the roadmap below for upcoming features like PDF splitting.
## 🎬 Real Life Scenario
- You receive an addendum from work on paper and scan it into separate files.
- You don't want to send your personal data to the cloud, nor do you want to install something big.
**The solution is this CLI program** - simply enter a command along with the path to the folder containing the scans, and after a moment, you'll have the **combined images in a single PDF**.
In three words:
### ✨ **Small, offline, and convenient!**
## ⚡ Install
Just type to install:
```ps1
dotnet tool install --global PrivatePdfConverter
```
and then just run it!
```ps1
ppc dir --path "D:\dir-with-images"
```
Example of logo command:
```ps1
ppc logo --path "D:\1.pdf" --logo-path "D:\logo.png" --position "bottom-left" --scale 25 --opacity 50 --output "newpdf"
```
## 📐 Arguments
| Argument | Description | Options | Optional options |
|-----------|-----------------------------------------------------------------|----------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| `dir` | Converts all images inside a directory to a single PDF file. | `path` - path to directory | `output` - PDF output name |
| | See below supported file extensions. | | |
| `img` | Converts a single image to a single PDF file. | `path` - path to image | `output` - PDF output name |
| | See below supported file extensions. | | |
| `merge` | Merges all PDF files inside a directory into a single PDF file. | `path` - path to directory | `output` - PDF output name |
| `encrypt` | Encrypts PDF with a password. | `path` - path to a PDF file | `output` - PDF output name |
| | | `password` - encryption password | |
| `logo` | Add image (logo) as a watermark to every page of PDF. | `path` - path to a PDF file | `output` - PDF output name |
| | | `logo-path` - path to logo image | `scale` - Specifies the scale of the image in percentage (e.g., 25 for 25%, 150 for 150%). Default value: 100. |
| | | | `opacity` - Specifies the opacity of the image in percentage (e.g., 25 for 25%, 0 for 0% - invisible) Default value: 100. |
| | | | `position` - Positions of logo. One of four values are accepted: `top-left`, `top-right`, `bottom-left`, `bottom-right`. |
| `ext` | Lists all valid image extensions. | | |
For all commends, default export .pdf file name is `output.pdf`.
### 📌 Supported file extensions
Type `ext` argument to list all of valid image extensions:
- .jpg
- .jpeg
- .bmp
- .gif
- .png
- .tif
- .tiff
- .webp
## 🗺️ Features roadmap
- [x] convert dir to pdf (`dir`)
- [x] create a PDF file from a single image (`img`)
- [x] multiple image extensions support
- [x] merge pdf (`merge`)
- [x] encrypt pdf with password (`encrypt`)
- [x] list all valid image extensions (`ext`)
- [x] add watermark/logo to your pdf (`logo`)
- [ ] convert PDF to multiple images (`???`)
- [ ] split pdf (`split`)
- [ ] better TUI (menu)
- [ ] set default export dir
## 🎯 Other
- [x] readme
- [x] features roadmap
- [x] editorconfig
- [x] logging
- [x] license
- [x] pipeline
- [x] better readme
- [x] cool dynamic labels (version, build, license, buymecoffe)
- [x] integration tests
- [ ] auto release from master [dotnet-releaser](https://github.com/xoofx/dotnet-releaser)
- [ ] exe release
- [ ] winget/chocolatey
## 🏅 Competition 100commitow
The project is part of the competition [100 commitow](https://100commitow.pl).
## ⌨️ Development
If you want to contribute, please take a look at the [Roadmap](#️-features-roadmap) or propose your own ideas.
Please create a **Pull Request** with a solution if you are eager to help. Keep in mind the structure of a solution. If you are going to create a new command, make sure to do it in the [Commands](./src/PrivatePdfConverter/Commands/) directory.
### Local
Build and run using [.NET 8.0](https://dotnet.microsoft.com/en-us/download):
```ps1
dotnet build
```
```ps1
.\PrivatePdfConverter.exe dir --path "D:\dir-with-images"
```
### 🔗 Dependencies
Based on micro-framework [Cocona](https://github.com/mayuki/Cocona).
### 📈 Sonar statistics
[](https://sonarcloud.io/summary/new_code?id=jurczewski_private-pdf-converter)
[](https://sonarcloud.io/summary/new_code?id=jurczewski_private-pdf-converter)
[](https://sonarcloud.io/summary/new_code?id=jurczewski_private-pdf-converter)
[](https://sonarcloud.io/summary/new_code?id=jurczewski_private-pdf-converter)
[](https://sonarcloud.io/summary/new_code?id=jurczewski_private-pdf-converter)
[](https://sonarcloud.io/summary/new_code?id=jurczewski_private-pdf-converter)
[](https://sonarcloud.io/summary/new_code?id=jurczewski_private-pdf-converter)
[](https://sonarcloud.io/summary/new_code?id=jurczewski_private-pdf-converter)
[](https://sonarcloud.io/summary/new_code?id=jurczewski_private-pdf-converter)
[](https://sonarcloud.io/summary/new_code?id=jurczewski_private-pdf-converter)