Welcome to lyrics-searcher 👋

A Simple Lyrics Finder That Just Works

Programmatic usage:

Installation

npm install --save lyrics-searcher

Usage

import lyricsSearcher from "lyrics-searcher";

lyricsSearcher("poets of fall", "carnival of rust")
  .then((lyrics) => {
    console.log(lyrics);
  })
  .catch((error) => {
    console.error(error);
  });

Command line usage:

Using without installation

npx lyrics-searcher "a r rahman" "kun faya kun"

Note: Use this method only if you plan to use lyrics-searcher for one time, installing lyrics-searcher globally (see-below) is recommended for multiple time usages.

Installation

npm install lyrics-searcher -g

Note for Linux & MacOS users: DO NOT use sudo to install global packages! The correct way is to tell npm where to install its global packages: npm config set prefix ~/.local. Make sure ~/.local/bin is added to PATH.

Usage after installation

lyrics-searcher "prateek kuhad" "cold mess"

Screenshot

API

For CLI usage, see the help option:

npx lyrics-searcher --help

For programmatic usage, use the default exported module. It takes two arguments. Artist name and Song name. It returns a promise which resolves into a string containing the lyrics if found, otherwise it will throw an exception (with an error message).

Author

👤 Rahil Kabani

• Website: https://alias-rahil.github.io
• Github: @alias-rahil
• Email: rahil.kabani.4@gmail.com

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

Lyrics-searcher

• 🏠 Homepage
• 📄 Readme
• 📦 Package

📝 License

Copyright © 2021 Rahil Kabani.
This project is MIT licensed.