nudge-cli

⚡ nudge-cli is a simple cross-platform reminder and notification CLI tool built with Node.js.

It lets you:

• Set reminders that trigger notifications later.
• List and manage pending reminders.
• Run a persistent background scheduler.

---

🚀 Installation

1. Install with NPM

npm install -g nudge-cli

2. Clone this repository:

git clone https://github.com/mrxgupta/nudge-cli.git
cd nudge-cli

Install dependencies:

npm install

Optionally link it globally (so you can run nudge from anywhere):

npm link

📦 Usage

You can run it either via the linked command:

nudge <command>

🛠️ Commands

Add a reminder

nudge add "Take a break in 10 minutes"

⏰ Supported time formats:

• seconds / s

• minutes / min / m

• hours / h

• days / d

Examples:

nudge add "Drink water in 20 minutes"
nudge add "Meeting in 2 hours"
nudge add "Call mom in 1 day"

List all reminders

nudge list

This will display all active reminders, and trigger any that are overdue.

Start the scheduler daemon

This keeps running in the background, checking for due reminders every 30 seconds:

nudge start

• You can also run this with PM2 or any process manager to keep it alive.

Fire a specific reminder manually (internal)

This is used internally for spawning reminder timers:

nudge fire <reminderId>

🧩 How It Works

• Reminders are saved in a local JSON database.

• When you add a reminder, it schedules a detached process to fire the notification.

• You can also run nudge start to keep a persistent scheduler running.

• Notifications are shown via the Node node-notifier library.

⚠️ Windows Users

Important

• If you are running on Windows, you must have Node.js installed and in your PATH.
• Notifications rely on node-notifier and may require enabling system notifications.

🧑‍💻 Development

If you want to modify the code:

• Clone the repo

• Install dependencies

• Edit the commands or lib files

Run commands using:

node bin/nudge.js <command>

🛡️ License

MIT License

❤️ Contributing

Feel free to open issues or pull requests!