Prly

Summarize your daily merged pull requests with AI — for any GitHub repo.

Prly is a command-line tool that fetches merged PRs from a GitHub repository, optionally filters them to the modules you own, generates an AI-powered summary using OpenAI, and can email the result to you — all in a single command.

Features

Fetches all merged PRs from any GitHub repository within a configurable date range
Filters PRs to only those that touch directories you own (your modules)
Generates a structured, section-by-section AI analysis (Problem / Change / Result) via OpenAI
Posts the result to a Microsoft Teams channel as a native Adaptive Card (version 1.4) via an incoming webhook
Sends the summary as an HTML email via any SMTP server
Works with a personal access token or the GitHub CLI (gh auth login) — no token setup required if you already use the CLI
Config stored in a single JSON file in your home directory — nothing committed to the repo

Prerequisites

Requirement	Version
Node.js	≥ 18
npm	≥ 9
GitHub token	Personal access token or GitHub CLI logged in
OpenAI API key	Required only for AI summarization (`--ai`)
SMTP credentials	Required only for email (`--email`)
Teams webhook	Required only for webhook delivery (`--webhook`)

Installation

From npm (recommended)

npm install -g @prly/prly

From source

# Clone the repository
git clone https://github.com/mohammadKarimi/Prly.git
cd Prly

# Install dependencies
npm install

# Build
npm run build

# Link globally so the `prly` command is available everywhere
npm link

Quick Start

# 1. Create your config interactively
prly config init

# 2. Set your secrets (add these to your shell profile for persistence)
export GITHUB_TOKEN=ghp_...
export OPENAI_API_KEY=sk-...
export EMAIL_USER=you@example.com
export EMAIL_PASS=your-smtp-password

# 3. Run a summary for yesterday's merged PRs
prly run

Environment Variables

All secrets are provided via environment variables. Prly loads a .env file from the current working directory automatically (via dotenv), or you can export them in your shell profile.

Variable	Required	Description
`GITHUB_TOKEN`	Optional†	GitHub personal access token with `repo` read scope. Falls back to `gh auth token` if not set.
`OPENAI_API_KEY`	Yes (`--ai`)	OpenAI API key for generating summaries.
`EMAIL_USER`	Yes (with `--email`)	SMTP username and the default sender/recipient address.
`EMAIL_PASS`	Yes (with `--email`)	SMTP password or app password.
`EMAIL_HOST`	No	SMTP host (e.g. `smtp.gmail.com`). Required when sending email.
`EMAIL_PORT`	No	SMTP port. Defaults to `587`.
`EMAIL_SECURE`	No	Set to `true` to use TLS (port 465). Defaults to `false`.
`WEBHOOK_URL`	Yes (with `--webhook`)	Incoming webhook URL for Microsoft Teams. Create one via Teams channel → Connectors → Incoming Webhook.
`GITHUB_API_BASE_URL`	No	Override the GitHub API base URL (e.g. for GitHub Enterprise). Defaults to `https://api.github.com`.

† If GITHUB_TOKEN is not set, Prly will call gh auth token automatically. Run gh auth login once and you never need to manage a token manually.

Example .env file:

GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxx
OPENAI_API_KEY=sk-proj-xxxxxxxxxxxxxxxxxxxx
EMAIL_USER=you@example.com
EMAIL_PASS=your-app-password
EMAIL_HOST=smtp.gmail.com
EMAIL_PORT=587
WEBHOOK_URL=https://your-org.webhook.office.com/webhookb2/...

Configuration File

Prly stores non-secret configuration in ~/.prly.config.json. Create or update it interactively with prly config init.

{
  "github": {
    "owner": "my-org", // GitHub organisation or username
    "repo": "my-repo", // Repository name
  },
  "myModules": [
    // Directory prefixes you own (optional)
    "src/features/auth",
    "libs/payments",
  ],
  "email": {
    "to": "team@example.com", // Recipient address (falls back to EMAIL_USER)
  },
  "llmOptions": {
    "outputLanguage": "English", // Language for the AI output, e.g. "Persian", "Spanish"
    "prompt": "...", // Custom system prompt sent to OpenAI
  },
}

myModules is the most important setting. When set, only PRs that touch at least one file inside those directories are included in the summary and email.

`llmOptions`

Field	Description	Default
`outputLanguage`	Natural language for the AI-generated summary, e.g. `"English"`, `"Persian"`, `"Spanish"`	`"English"`
`prompt`	Full system prompt sent to OpenAI. Omit to use the built-in release-notes prompt.	Built-in prompt

Commands

`run`

Fetch, filter, and summarize your PRs. Outputs and delivery channels are opt-in — nothing is sent unless you explicitly ask.

prly run [options]

Option	Description	Default
`--since <date>`	Start of the date range (`YYYY-MM-DD`)	Yesterday
`--until <date>`	End of the date range (`YYYY-MM-DD`)	Today
`--ai`	Generate an AI summary via OpenAI	Off
`--email`	Send the summary by email	Off
`--webhook`	Build a Teams Adaptive Card with AI and post it to the configured webhook	Off
`--verbose`	Print each PR's changed files while filtering by modules	Off

`list`

List PRs that touch your modules, without summarizing or emailing.

prly list [options]

Option	Description	Default
`--since <date>`	Start of the date range (`YYYY-MM-DD`)	Yesterday
`--until <date>`	End of the date range (`YYYY-MM-DD`)	Today

`list-all`

List all merged PRs in the repo with no module filter. Useful for debugging your module paths.

prly list-all [options]

Option	Description	Default
`--since <date>`	Start of the date range (`YYYY-MM-DD`)	Yesterday
`--until <date>`	End of the date range (`YYYY-MM-DD`)	Today

`config init`

Interactively create or update your config file (~/.prly.config.json).

prly config init

Prompts for GitHub owner, repo, email recipient, and module paths. Re-running this command preserves your existing values as defaults.

`config show`

Print the current configuration as JSON.

prly config show

`config add-module`

Add a directory path to your modules list without re-running the full wizard.

prly config add-module <path>

Argument	Description
`<path>`	Directory prefix to add, e.g. `src/features/auth`

`config remove-module`

Remove a directory path from your modules list.

prly config remove-module <path>

Argument	Description
`<path>`	Directory prefix to remove

`config test`

Verify that your GitHub token is valid and that Prly can reach the configured repository.

prly config test

Examples

# List yesterday's PRs (no AI, no delivery)
prly run

# Summarize with AI only — inspect the output before wiring up delivery
prly run --ai

# Post an Adaptive Card to Teams (AI analyses PRs, card is built from that analysis)
prly run --ai --webhook

# Summarize a specific date range and email the result
prly run --since 2026-03-01 --until 2026-03-07 --ai --email

# Summarize this week and post to Teams only (no email)
prly run --since 2026-03-16 --ai --webhook

# Full delivery: AI summary + email + Teams Adaptive Card
prly run --ai --email --webhook

# Webhook-only (card generated directly from raw PR data, no separate text summary)
prly run --webhook

# See which files each PR touched while filtering
prly run --verbose

# Quick check of what merged yesterday (no outputs)
prly list

# See every merged PR (ignore module filter), useful when setting up modules
prly list-all --since 2026-03-01

# Add a new module path
prly config add-module src/billing

# Remove an old module path
prly config remove-module libs/legacy

Contributing

Contributions are welcome! Please follow these steps:

Fork the repository and create a feature branch: git checkout -b feat/my-feature
Install dependencies: npm install
Make your changes in src/
Build and verify: npm run build
Open a pull request with a clear description of the change

Please keep PRs focused — one feature or fix per PR.

Name		Name	Last commit message	Last commit date
Latest commit History 16 Commits
.github/workflows		.github/workflows
dist		dist
src		src
.env.example		.env.example
.gitignore		.gitignore
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
prly.config.json		prly.config.json
tsconfig.json		tsconfig.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Prly

Table of Contents

Features

Prerequisites

Installation

From npm (recommended)

From source

Quick Start

Environment Variables

Configuration File

`llmOptions`

Commands

`run`

`list`

`list-all`

`config init`

`config show`

`config add-module`

`config remove-module`

`config test`

Examples

Contributing

License

About

Uh oh!

Releases 5

Packages

Uh oh!

Contributors

Uh oh!

Languages

Folders and files

Latest commit

History

Repository files navigation

Prly

Table of Contents

Features

Prerequisites

Installation

From npm (recommended)

From source

Quick Start

Environment Variables

Configuration File

llmOptions

Commands

run

list

list-all

config init

config show

config add-module

config remove-module

config test

Examples

Contributing

License

About

Topics

Resources

Uh oh!

Stars

Watchers

Forks

Releases 5

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

`llmOptions`

`run`

`list`

`list-all`

`config init`

`config show`

`config add-module`

`config remove-module`

`config test`

Packages