Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/altamsh04/reminder-cli
A simple node command-line tool that allows users to set reminders for tasks or events directly from the terminal.
https://github.com/altamsh04/reminder-cli
cli js node npm-package
Last synced: about 1 month ago
JSON representation
A simple node command-line tool that allows users to set reminders for tasks or events directly from the terminal.
- Host: GitHub
- URL: https://github.com/altamsh04/reminder-cli
- Owner: altamsh04
- License: mit
- Created: 2024-12-04T20:53:38.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-23T17:38:48.000Z (about 1 month ago)
- Last Synced: 2024-12-23T18:27:39.703Z (about 1 month ago)
- Topics: cli, js, node, npm-package
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@altamsh04/reminder-cli
- Size: 313 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Reminder CLI
## Overview
Reminder CLI is a lightweight, user-friendly command-line tool designed to help you manage tasks and reminders directly from your terminal. With simple and intuitive commands, you can quickly set, list, and track your personal reminders.
## Prerequisites
- Node.js (v14.0.0 or higher)
- npm (v6.0.0 or higher)
## Installation
Install Reminder CLI globally using npm:
```bash
npm install -g @altamsh04/reminder-cli
```
## Usage
### Initialize the CLI
```bash
reminder init
```
### Set a Reminder without scheduling
```bash
reminder set "Buy groceries for weekend"
```
### Set a Reminder with scheduling ( Use '1s', '1m', or '1h')
```bash
reminder set "Take medicine" -i 30m
or
reminder set "Meeting with team at 2 PM" --in 1h
```
### List Reminders
```bash
reminder list
or
reminder ls
```
### Clear Reminders
```bash
reminder clear
or
reminder cls
```
## Commands
- `reminder init`: Initialize the reminder tool
- `reminder set `: Add a new reminder
- `reminder set --in
## Contributing
Contributions, issues, and feature requests are welcome! Feel free to check [issues page](https://github.com/altamsh04/reminder-cli/issues).
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License.
## Maintainers
- [@altamsh04](https://github.com/altamsh04)