pompelmi Files

What's New

HTML Security Dashboard

Generate a beautiful, self-contained scan report in one command:

:::bash
npx pompelmi scan ./uploads --report
npx pompelmi scan ./uploads --report --output report.html

Or from code:

:::js
const { scanDirectory, generateDashboard } = require('pompelmi')

const results = await scanDirectory('./uploads')
const html = await generateDashboard(results)
fs.writeFileSync('report.html', html)

Features:

• Summary stats: scanned, infected, clean, errors, time
• Color-coded status banner (green / red)
• Full file table with verdict badges
• Infected files highlighted with virus names
• Dark mode support
• Print-friendly CSS
• Zero external dependencies — single self-contained HTML file

SVG Share Card

Generate a shareable scan result card for README badges or social media:

:::bash
npx pompelmi scan ./uploads --share-card
# saves pompelmi-scan-card.svg

:::js
const { generateShareCard } = require('pompelmi')
const svg = await generateShareCard(results)

Next.js Package

@pompelmi/nextjs is now available on npm:

:::bash
npm install @pompelmi/nextjs pompelmi

:::js
// App Router (Next.js 13+)
import { withPompelmi } from '@pompelmi/nextjs'

export const POST = withPompelmi(async (req) => {
  return Response.json({ ok: true })
}, { host: 'localhost', port: 3310 })

// Pages Router
export default withPompelmiHandler(handler, options)

GitHub App

Configuration for a one-click pompelmi GitHub App for organizations — no workflow file needed, scans changed files on every PR with inline annotations on the diff.

See docs/github-app.html for setup instructions.

Framework Integrations

Changes

• src/Dashboard.js — HTML report generator
• src/ShareCard.js — SVG share card generator
• bin/pompelmi.js — --report and --share-card flags added
• packages/nextjs/ — Next.js App Router and Pages Router support
• .github/app.yml — GitHub App configuration
• docs/dashboard.html — dashboard documentation
• docs/github-app.html — GitHub App documentation
• docs/*.html — navbar updated with new pages
• README.md — Features list updated

Full Changelog

https://github.com/pompelmi/pompelmi/compare/v1.13.0...v1.14.0