cloakpdf

KO | EN

gitlite — search

#python #react #javascript #hacktoberfest #api #typescript #hacktoberfest-accepted #hacktoberfest2022 #python3 #minecraft #nft #css

★ 13 Open GitHub ↗

A fast, modern, and privacy-focused PDF toolkit that runs entirely in your browser. No uploads, no servers, no tracking — your files never leave your device.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

A fast, private PDF toolkit that runs entirely in your browser.
 No uploads, no servers, no tracking — your files never leave your device.

<a href="https://pdf.cloakyard.com/">pdf.cloakyard.com</a>

</div>

---

## ✨ What it does

Drop a PDF and it opens in a single, canvas-based **editor** — a Photoshop-like workspace for one document at a time. **22 editor tools and 7 standalone utilities** cover everything from a quick tick on a printed form to redaction, OCR, and on-device AI:

- **✏️ Annotate & sign** — draw, highlight, shapes, text (14 fonts, **bold** / _italic_ / underline), form-filling icons (tick / cross / dot / circle), signatures (draw with a real-pen ink feel, or a pressure-sensitive stylus — Apple Pencil, Wacom, S-Pen), fill & flatten forms (or auto-fill flat printed ones)
- **📄 Pages** — reorder, rotate, delete, crop (auto-trim & straighten), strip repeating headers/footers, N-up & booklet, OCR, plus split / extract / contact-sheet on export
- **🔒 Privacy** — redact (burned into the page), select or find & box text, erase regions (fill / blend / pixelate), scrub hidden data, edit or strip metadata
- **🏷️ Stamps & numbering** — watermarks (with dynamic date/page tokens), QR & barcode stamps, page numbers, headers & footers, Bates numbering, bookmarks, file attachments

Export to PDF, images (ZIP), a contact sheet, or split pages — with optional compress / grayscale / flatten / repair / strip-metadata.

The editor is keyboard-friendly: press **⌘K / Ctrl+K** to jump to any tool from a command palette, and undo/redo with the usual shortcuts.

A few **standalone tools** cover the jobs the single-PDF editor can't — these mirror the categories on the home screen:

- **🧩 Combine & Convert** — merge PDFs, build a PDF from images, or extract embedded images
- **🔑 Secure & Sign** — add a password & permissions, sign with a certificate, or compare two PDFs
- **🤖 On-device AI** — _Ask your PDF_: chat with a document using a small model that runs entirely in your browser, no API key or server

---

## 🛡️ Privacy first

Everything runs client-side — there is no server to upload to. No accounts, no analytics, no tracking. It's an installable PWA that keeps working offline once loaded, and the on-device AI needs no API key or inference server.

---

## 🧰 Tech stack

| Area             | Technology                                                                                                                   |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| Framework        | [React 19](https://react.dev/) + [TypeScript 7](https://www.typescriptlang.org/)                                             |
| Styling          | [Tailwind CSS 4](https://tailwindcss.com/)                                                                                   |
| Build & tooling  | [Vite+ (`vp`)](https://viteplus.dev/)                                                                                        |
| PDF manipulation | [@pdfme/pdf-lib](https://github.com/pdfme/pdf-lib)                                                                           |
| PDF rendering    | [PDF.js](https://mozilla.github.io/pdf.js/)                                                                                  |
| Layout-aware OCR | [LlamaIndex LiteParse](https://www.llamaindex.ai/liteparse) + [Tesseract.js](https://tesseract.projectnaptha.com/)           |
| On-device AI     | [Transformers.js](https://github.com/huggingface/transformers.js) + [LangGraph](https://langchain-ai.github.io/langgraphjs/) |
| Deployment       | [Cloudflare Workers](https://workers.cloudflare.com/)                                                                        |

---

## 🚀 Getting started

```bash
git clone https://github.com/cloakyard/cloakpdf.git
cd cloakpdf
vp install   # needs Node ≥ 24 and `npm i -g vite-plus`
vp dev       # http://localhost:5173
```

| Command               | Description                                                  |
| --------------------- | ------------------------------------------------------------ |
| `vp dev`              | Dev server with hot reload                                   |
| `vp build`            | Type-check + production build                                |
| `vp check`            | Format, lint, type-check                                     |
| `pnpm check:dead`     | Audit unused code and dependencies                           |
| `vp test`             | Run unit tests                                               |
| `pnpm generate-icons` | Rebuild PWA, touch, and legacy icons from the app-icon SVG   |
| `pnpm generate-og`    | Capture the current landing page as the 1200×630 social card |

---

## 🎨 Brand assets

CloakPDF follows the shared Cloakyard mark and installed-app icon contract in
**[docs/logo-spec.md](docs/logo-spec.md)**. The circular UI mark lives at
`public/cloakpdf-mark.svg`; installable PWA assets are generated from the
separate, full-bleed `public/icons/cloakpdf-app-icon.svg`.

After changing either source, run `pnpm generate-icons` and then
`pnpm generate-og`. The latter captures the real landing page so the social
preview stays aligned with the current logo and UI.

---

## 🤖 On-device AI

**Ask your PDF** runs a full retrieval-augmented Q&A pipeline in the browser — the model weights download once from Hugging Face, cache, and work offline after. For the architecture (LangGraph state machine, hybrid retrieval, model choices), see **[docs/local-ai.md](docs/local-ai.md)**.

---

## 🤝 Contributing & license

Contributions are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md). Licensed under the [MIT License](LICENSE).

Built with ❤️ by <a href="https://github.com/sumitsahoo">Sumit Sahoo</a>

cloakpdf

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README