Skip to content

Latest commit

 

History

History
93 lines (60 loc) · 2.24 KB

README.md

File metadata and controls

93 lines (60 loc) · 2.24 KB
Raw

Lowfi 🎵

Play Lofi music through your terminal.

npm | Buy Me a Coffee

Table of Contents

Installation

To install Lowfi, you need Node.js and npm installed on your machine. You can install the CLI tool globally using the following command:

npm install -g lowfi

Usage

After installation, you can run the CLI tool using the following command:

lowfi [command] [options]

To see a list of available commands and options, run:

lowfi --help

Commands

play

Play a lofi playlist.

lowfi play

Options:

  • --random: Randomly select a playlist.
  • --volume <number>: Set the volume (between 0 and 1).

open

Open a playlist in your browser.

lowfi open

Prerequisites

  • ffmpeg: Converting audio formats.
  • node-gyp: Compiling native addon modules.

Contributing

We welcome contributions from the community! If you'd like to contribute, please 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 a descriptive commit message.
  4. Push your changes to your fork.
  5. Open a pull request with a detailed description of your changes.

Please make sure to follow our Contributing Guidelines.

Support

If you find this project useful, please consider supporting it by giving it a star on GitHub. Your support helps us continue to improve and maintain the project.

You can also support the project by making a donation. Every little bit helps and is greatly appreciated!

Thank you for your support!

License

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

Thank you for using Lowfi! If you have any questions or feedback, please open an issue on GitHub.