lyricsgenius-js

A Node.js client for the Genius.com API 🎶🎤

中文版 README

This is a Node.js port of the popular Python lyricsgenius library, providing access to song lyrics, artist information, and albums from Genius.com.

Quick Start

Install the package

npm install lyricsgenius-js

# Or install globally to use CLI commands
npm install -g lyricsgenius-js

Set up your API token

1. Get your token from Genius API
2. Configure it using the CLI:

lyricsgenius init

CLI Usage

The package includes a powerful CLI tool with several commands and convenient aliases:

Initialize Configuration

lyricsgenius init

Interactive Setup Process:

1. 🔑 Enter your Genius API token
2. 📍 Choose configuration location:
   • Global (default): Saves to ~/.lyricsgenius/config.json
   • Local: Creates lyricsgenius.config.json in current directory

Smart Local Configuration:

• If lyricsgenius.config.json.example exists, it's used as a template
• Your token is automatically inserted while preserving other settings
• Perfect for project-specific configurations with custom outputPath templates

Project-specific Configuration

You can create local configuration in two ways:

Method 1: Using init command (Recommended)

lyricsgenius init
# Choose "Yes" when asked about local configuration

Method 2: Manual creation Create a lyricsgenius.config.json file in your project directory:

{
  "outputPath": "./music/{{artist}}/albums",
  "accessToken": "your_token_here"
}

Template Variables:

• {{artist}} - Artist name (sanitized for file system)

The local configuration takes precedence over global configuration.

Interactive Search and Download

# Interactive search with song selection and download
lyricsgenius search "Shape of You"
lyricsgenius s "Shape of You"  # Short alias

# Customize number of results
lyricsgenius search "Hello" -l 20

Interactive Experience:

1. 🔍 Search shows a list of songs
2. 📋 Select a song from the interactive menu
3. 📁 Choose download directory (with template-aware defaults)
4. 📄 Select format (txt or json)
5. 🎉 Automatic download with organized folder structure

The CLI automatically detects lyricsgenius.config.json in your current directory and uses the outputPath template for default download locations.

Direct Download

# Download specific song by ID
lyricsgenius download 1234567
lyricsgenius dl 1234567  # Short alias

# Download to custom directory
lyricsgenius download 1234567 -o ~/Music/

# Download as JSON format
lyricsgenius download 1234567 -f json

Diagnostics

lyricsgenius doctor
lyricsgenius doc  # Short alias

Runs comprehensive tests including:

• 🔌 API connection testing
• 🔍 Search functionality verification
• 🌐 Proxy configuration testing
• 🩺 Full system diagnostics

Command Aliases

All CLI commands support convenient short aliases for faster typing:

# These are equivalent
lyricsgenius search "hello world"
lyricsgenius s "hello world"

# These are equivalent  
lyricsgenius download 12345
lyricsgenius dl 12345

# These are equivalent
lyricsgenius doctor
lyricsgenius doc

API Token Setup

You can set your API token using several methods:

CLI Configuration (Recommended):

lyricsgenius init

Environment Variable:

export GENIUS_ACCESS_TOKEN="your_token_here"

Programmatically:

const genius = new Genius({ accessToken: 'your_token_here' });

Programmatic Usage

Basic Usage

import { Genius } from 'lyricsgenius-js';
// or: const { Genius } = require('lyricsgenius-js');

// Initialize with access token
const genius = new Genius({ accessToken: 'your_access_token_here' });

// Or use environment variable GENIUS_ACCESS_TOKEN
const genius = new Genius();

Search for Songs

// Search for a specific song
const song = await genius.searchSong('Song Title', 'Artist Name');
if (song) {
  console.log(song.title);
  console.log(song.artist);
  console.log(song.lyrics);
}

Search for Artists

// Search for an artist and get their songs
const artist = await genius.searchArtist('Artist Name', 5); // Get 5 songs max
if (artist) {
  console.log(`Found ${artist.numSongs} songs by ${artist.name}`);
  for (const song of artist.songs) {
    console.log(`- ${song.title}`);
  }
}

Search for Albums

// Search for an album by ID (album name search no longer supported by API)
const album = await genius.searchAlbum(12345);
if (album) {
  console.log(`Album: ${album.name} by ${album.artistName}`);
  console.log(`Tracks: ${album.numTracks}`);

  // Save album data to JSON file
  album.saveLyrics();
}

Configuration Options

const genius = new Genius({
  accessToken: 'your_token',
  verbose: false,                    // Turn off status messages
  removeSectionHeaders: true,        // Remove [Chorus], [Verse] etc from lyrics
  skipNonSongs: false,              // Include non-song results
  excludedTerms: ['Remix', 'Live'], // Skip songs with these terms
  timeout: 10000,                   // Request timeout in ms
  retries: 2                        // Number of retries on failure
});

Development

npm install          # Install dependencies
npm run build       # Compile TypeScript
npm run dev         # Watch mode for development
npm run doctor      # Run diagnostic tool

Examples

Run the included examples:

# Basic song search
npm run example:basic

# Artist search with multiple songs
npm run example:artist

# Proxy configuration examples
npm run example:proxy

Or check the examples/ directory for code samples.

Features

• Interactive CLI: Modern command-line interface with interactive menus and shortcuts
• Project Configuration: Local lyricsgenius.config.json with template-based output paths
• Template Variables: Customize download paths with {{artist}} variables
• TypeScript Support: Complete type definitions for TypeScript projects
• Promise-based API: Modern async/await syntax
• Configurable: Extensive options for customizing behavior
• Rate limiting: Built-in request throttling and retry logic
• OAuth2 Support: Complete OAuth2 flow implementation
• Web scraping: Lyrics extraction from Genius web pages
• Command Aliases: Short aliases for faster CLI usage

API Reference

Main Classes

• Genius - Main client class for interacting with Genius API
• Song - Represents a song with lyrics and metadata
• Artist - Represents an artist with their songs
• Album - Represents an album with tracks
• OAuth2 - OAuth2 authentication helper

License

MIT

Contributing

This is a Node.js port of the Python lyricsgenius library. Issues and pull requests are welcome!

Changelog

See CHANGELOG.md for a detailed history of changes and new features.