omen-cli

A CLI to customize your keyboard backlight 🚀
Explore the docs »

View Demo · Report Bug · Request Feature

🎯 Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contributors

📖 About The Project

omen-cli is a lightweight CLI tools built in C# to customize keyboard backlights on HP Omen laptops similar to how Omen Light studio does.

Built With

• C#
• .Net Framework 4.8
• CommandLineParser

✈️ Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• .NET Framework 4.8
• Nuget.exe CLI
• MSBuild.exe CLI

Installation

1. Clone the repo

git clone https://github.com/thebongy/omen-cli.git

2. Install dependencies

nuget install .\CLI\packages.config -OutputDirectory packages

3. Run the following command from the root dir to build the project

MSBuild.exe

🔧 Usage

To view all the options available, use the --help command:

The set4 command is used to set 4 colors to the 4 zones on the keyboard.

The set1 command is used to set the same color to all 4 zones.

--type can either be rgb or name, to give the colors in different formats. For example:

🗺️ Roadmap

See the open issues for a list of proposed features (and known issues).

🦾 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push -u origin feature/AmazingFeature)
5. Open a Pull Request

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project 😄.

📄 License

Distributed under the MIT License. See LICENSE for more information.