s1d007 / redowl-cli

RedOwl CLI is a handy productivity tool designed to promote healthy eye habits while working on your computer. It reminds users to take regular breaks and blink their eyes to reduce eye strain and fatigue. With customizable intervals and durations, RedOwl helps you maintain optimal eye health and productivity throughout your workday.

RedOwl CLI

RedOwl CLI is a productivity tool designed to help users take regular breaks and blink their eyes to prevent eye strain. With customizable intervals and durations, RedOwl ensures you maintain healthy eye habits while working on your computer.

Table of Contents

1. Features
2. Installation
   • Using the Script
   • Manual Installation
3. Usage
4. Configuration
   • JSON Configuration
   • YAML Configuration
5. Contributing
6. License

Features

• Set reminders to blink your eyes at regular intervals.
• Customize the duration of breaks.
• Supports JSON and YAML configuration files.
• Plays a sound to alert you when it's time to take a break and when the break ends.
• Logs the number of completed sessions and the time remaining for the next break.

Installation

Using the Script

You can easily install RedOwl CLI using the following command. This script will check for Node.js and Yarn, clone the repository, install dependencies, and set up the CLI tool.

curl -sSL https://raw.githubusercontent.com/S1D007/redowl-cli/main/install.sh | bash

Manual Installation

1. Clone the Repository:

   git clone https://github.com/S1D007/redowl-cli
   cd redowl-cli

2. Install Dependencies:

   pnpm install

3. Compile TypeScript Files:

   pnpm run build

4. Link the CLI Globally:

   pnpm run local-link

Usage

Once installed, you can use the redowl command to start the CLI tool. Here are some basic commands:

• Start the CLI:

  redowl start --every 20m --for 20s

  This command sets a reminder to blink every 20 minutes for 20 seconds.

• Show Help:

  redowl --help

Configuration

RedOwl CLI supports both JSON and YAML configuration files for setting up custom intervals and durations.

JSON Configuration

Create a config.json file with the following structure:

{
  "every": "20m",
  "for": "20s"
}

YAML Configuration

Create a config.yaml file with the following structure:

every: "20m"
for: "20s"

Contributing

We welcome contributions from the community! To contribute, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your fork.
5. Open a pull request to the main branch of the original repository.

Please ensure your code follows our coding standards and includes relevant tests.

License

This project is licensed under the MIT License. See the LICENSE file for details.