Pompelmi

What's New

Standalone CLI

Scan files directly from the terminal — no code required:

# Scan a file
npx pompelmi scan ./uploads/file.pdf

# Scan a directory recursively
npx pompelmi scan ./uploads --recursive

# Output as JSON for scripting
npx pompelmi scan ./uploads --json

# Watch a folder in real time
npx pompelmi watch ./uploads

Features:

• Renders the pompelmi grapefruit logo in the terminal via terminal-image
• Live progress bar for directory scans
• Box-drawing UI with color-coded results (green/red/yellow)
• --json mode for shell script integration
• --delete flag to auto-remove infected files
• --quiet mode for CI pipelines
• Works with TCP, UNIX socket, and local clamscan

Exit codes: 0 clean · 1 infected · 2 scan error · 3 clamd unreachable

Install globally:

npm install -g pompelmi
pompelmi scan ./uploads

Or use without installing:

npx pompelmi scan ./uploads

CLI Documentation

New dedicated page: docs/cli.html

• Full commands and options reference
• JSON output format
• Exit codes table
• 8 real-world examples
• Shell script integration

Navbar updated across all docs

All docs/ pages now have a consistent navbar including the new CLI link.

Changes

• bin/pompelmi.js — full CLI implementation
• package.json — bin field added, terminal-image dependency
• docs/cli.html — new CLI documentation page
• docs/*.html — navbar updated across all pages
• README.md — Quick Start section, CLI in Features and docs table
• CHANGELOG.md — v1.12.0 entry

Full Changelog

https://github.com/pompelmi/pompelmi/compare/v1.11.0...v1.12.0