Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alias-rahil/lyrics-searcher
A Simple Lyrics Finder That Just Works
https://github.com/alias-rahil/lyrics-searcher
azlyrics cli genius google javascript lyrics-fetcher lyrics-finder lyrics-searcher musixmatch rapidapi scrape song typescript
Last synced: about 1 month ago
JSON representation
A Simple Lyrics Finder That Just Works
- Host: GitHub
- URL: https://github.com/alias-rahil/lyrics-searcher
- Owner: alias-rahil
- License: mit
- Created: 2021-06-25T12:16:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-07T08:40:53.000Z (almost 2 years ago)
- Last Synced: 2024-11-12T08:00:46.310Z (about 2 months ago)
- Topics: azlyrics, cli, genius, google, javascript, lyrics-fetcher, lyrics-finder, lyrics-searcher, musixmatch, rapidapi, scrape, song, typescript
- Language: TypeScript
- Homepage: https://alias-rahil.github.io/lyrics-searcher/
- Size: 621 KB
- Stars: 35
- Watchers: 3
- Forks: 7
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Welcome to lyrics-searcher 👋
> A Simple Lyrics Finder That Just Works
## Programmatic usage:
### Installation
```sh
npm install --save lyrics-searcher
```
### Usage
```ts
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
```sh
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
```sh
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
```sh
lyrics-searcher "prateek kuhad" "cold mess"
```
## Screenshot
## API
For CLI usage, see the help option:
```sh
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](https://github.com/alias-rahil)
* Email: [email protected]
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/alias-rahil/lyrics-searcher/issues). You can also take a look at the [contributing guide](https://github.com/alias-rahil/lyrics-searcher/blob/main/.github/CONTRIBUTING.md).
## Show your support
Give a ⭐️ if this project helped you!
## Lyrics-searcher
* 🏠 [Homepage](https://alias-rahil.github.io/lyrics-searcher)
* 📄 [Readme](https://github.com/alias-rahil/lyrics-searcher#readme)
* 📦 [Package](https://www.npmjs.com/package/lyrics-searcher)
## 📝 License
Copyright © 2021 [Rahil Kabani](https://github.com/alias-rahil).
This project is [MIT](https://github.com/alias-rahil/lyrics-searcher/blob/main/LICENSE) licensed.