NPM Package Documentation

Automatic social media content generation for your code releases. Install once, works forever—just like Sentry.

npm install pubdev

v0.2.0

Zero Config

Works out of the box with sensible defaults for Next.js, React, and more

CI/CD Ready

Integrates seamlessly with GitHub Actions, Vercel, Netlify

Secure

API key authentication, encrypted communication, no source code storage

Installation

Install the pubdev package in your project

Using npm:

npm install -D pubdev

Using pnpm:

pnpm add -D pubdev

Using yarn:

yarn add -D pubdev

Get Your API Key

You'll need an API key to use the package

Initialize in Your Project

Run the init command to set up pubdev

npx pubdev init

Follow the interactive prompts to configure your project. This creates a pubdev.config.js file.

Manual Scanning

Scan your project for changes

Scan entire project:

npx pubdev scan

Scan specific files:

npx pubdev scan app/dashboard/page.tsx components/NewFeature.tsx

Scan changes since a commit:

npx pubdev scan --since HEAD~5

How It Works

The pubdev workflow in 6 simple steps

Need Help?

Get support from the pubdev team

🏠 Homepage:pubdev.app