Skip to content

incognito-byte/notify-tool

Repository files navigation

Notify Tool

Tests

Run any command and automatically create a GitHub issue when it finishes.

notify is a lightweight CLI tool that runs any script or command and notifies you by creating a GitHub issue upon completion — whether the command succeeds or fails. It supports per-project configuration via a .notify file or uses a default notifications repository.

Features

  • Run any command (npm, bun, go, etc.) and track its result
  • Automatically create a GitHub issue on success or failure
  • Supports .notify config files for per-repo customization
  • Automatically creates a default notifications repository if none is specified
  • Prompts to install gh CLI if it's missing
  • Interactive setup with notify init

Installation

Globally via npm:

npm install -g notify-tool

Example

Let's say you have a long-running build process:

# Initialize notify in your project (creates .notify config)
notify init

# Run any command with notifications
notify "npm run build"

# If command succeeds, creates an issue like:
# [Notification] ✅ Success
# Command: go run main.go
# Result: ✅ Success
# Time: 10/5/2025, 3:23:25 PM
# Working Directory: /path

# If build fails, creates an issue like:
# [Notification] ❌ Failed (exit 1)
# Command: go run main.go
# Result: ❌ Failed (exit 1)
# Time: 10/5/2025, 6:52:49 PM
# Working Directory: /path

Configuration

Create a .notify file in your project root:

{
  "repo": "username/notifications-repo"
}

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

 
 
 

Contributors