leshicodes/lrclib-fetcher repository overview

npm install -g lrclib-fetcher-ts

npm install lrclib-fetcher-ts

lrclib /path/to/your/music

Options:
  -r, --recursive                Scan directories recursively (default: true)
  --no-skip-existing             Don't skip files that already have lyrics
  -o, --overwrite                Overwrite existing lyrics files (default: false)
  -b, --batch-size <number>      Number of files to process in parallel (default: "5")
  -d, --delay <number>           Delay between API requests in milliseconds (default: "1000")
  --allow-title-only             Allow searching by title only if artist search fails (default: false)
  --prefer-synced                Prefer synchronized lyrics over plain text (default: true)
  --log-level <level>            Log level (debug, info, warn, error) (default: "info")
  --log-file <path>              Path to log file
  -h, --help                     Display help
  -V, --version                  Show version

# Process a directory with default settings
lrclib ~/Music

# Process with custom options
lrclib ~/Music --overwrite --batch-size 10 --delay 2000

# Only process files without existing lyrics
lrclib ~/Music --skip-existing

# Write logs to a file
lrclib ~/Music --log-level debug --log-file lyrics.log

docker pull leshicodes/lrclib-fetcher:0.0.2

docker run -v "/path/to/your/music:/music" leshicodes/lrclib-fetcher:0.0.2

docker build -t lrclib-fetcher .

docker run -v "/path/to/your/music:/music" lrclib-fetcher

docker run -v "/path/to/your/music:/music" leshicodes/lrclib-fetcher:0.0.2 /music --overwrite --batch-size 10

import { createLyricsFetcher } from 'lrclib-fetcher-ts';

// Create a fetcher with custom options
const fetcher = createLyricsFetcher({
  logging: { 
    level: 'info',
    logToFile: false
  },
  search: {
    allowTitleOnlySearch: true,
    preferSynced: true
  },
  file: {
    skipExisting: true,
    overwriteExisting: false
  },
  batch: {
    enabled: true,
    size: 5,
    delayMs: 1000
  }
});

// Process a directory
fetcher.processDirectory('/path/to/music')
  .then(results => {
    console.log(`Processed ${results.length} files`);
    console.log(`${results.filter(r => r.success).length} successful`);
  })
  .catch(error => {
    console.error('Error:', error);
  });