Package Exports
- @hernad/claude-ntfy
- @hernad/claude-ntfy/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@hernad/claude-ntfy) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
claude-ntfy
TUI application for sending notifications to ntfy.sh about project progress.
Features
- Send notifications about PR status (open/merged)
- Send "stuck" notifications with appropriate emojis
- Terminal-based user interface
- Command-line interface for automation
- Automatic process exit after command completion
- Clean shutdown for both CLI and TUI interfaces
- Working message sending to ntfy.sh servers
Installation
npm install -g @hernad/claude-ntfy
Usage
Command Line Interface (CLI)
# Send a notification
claude-ntfy send "Your message" "Optional title" tag1 tag2
# Example: Send a notification about a feature
claude-ntfy send "Working on feature #1247" "Project 2 update" work progress
# View current settings
claude-ntfy settings
# Update settings
claude-ntfy settings set https://ntfy.cloud.out.ba claude
# Get the current version
claude-ntfy --version
Terminal User Interface (TUI)
# Start the TUI application
claude-ntfy-tui
In the TUI:
- Use ↑/↓ arrow keys to navigate the menu
- Press Enter to select an option
- Press ESC or Q to exit
Development
To install dependencies:
bun install
To run in development mode:
# CLI mode
bun run dev
# TUI mode
bun run dev:tui
To build:
bun run build
To run tests:
bun test
Configuration
The application uses a settings file located at ~/.claude-ntfy/settings.json
with the following structure:
{
"server": "https://ntfy.cloud.out.ba",
"topic": "claude"
}
You can modify these settings using the CLI command:
claude-ntfy settings set <server-url> <topic-name>
GitHub Actions
This repository uses GitHub Actions for continuous integration and deployment:
- Tests are automatically run on every push and pull request
- When code is pushed to the main branch and tests pass, a new version is automatically published to npm
To publish a new version:
- Update the version in
package.json
- Run
npm run release
to create a new release - Push the changes and tag to GitHub
- GitHub Actions will automatically publish to npm
Published Versions
- v0.2.0 - Initial public release