https://github.com/alexanderwallin/guess-id3

Extracts artist name and song title from filenames and writes them as ID3 to those files
https://github.com/alexanderwallin/guess-id3

Last synced: 4 days ago
JSON representation

Extracts artist name and song title from filenames and writes them as ID3 to those files

• Host: GitHub
• URL: https://github.com/alexanderwallin/guess-id3
• Owner: alexanderwallin
• License: unlicense
• Created: 2017-06-06T16:44:28.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-06-12T11:39:33.000Z (over 7 years ago)
• Last Synced: 2024-11-06T17:52:31.370Z (9 days ago)
• Language: JavaScript
• Homepage:
• Size: 34.2 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# guess-id3

Extracts artist name and song title from filenames and writes them as ID3 v2.3 to those files.

## Installation

```sh

# For use in JavaScript

npm install guess-id3

# For use from the command line

npm install -g guess-id3

```

## Usage

### From the command line

```sh

$ guess-id3 [--dry] [--verbose] 'music/**/*.mp3'

```

### In JavaScript

```js

import guessId3 from 'guess-id3'

guessId3('music/**/*.mp3', { dry: false, verbose: false }).then(() => {

  console.log('Done!')

})

```

## API

### `guessId3(glob, options)`

Overwrites all files matched by `glob` with a buffer that contains ID3 metadata. The data is extracted from a file's name using [`guess-metadata`](https://www.npmjs.com/package/guess-metadata).  As an example, the filename `Artist Name - Song Title.mp3` gives `{ artist: 'Artist Name', title: 'Song Title' }`.

* `glob` - A glob accepted by [`glob-all`](https://www.npmjs.com/package/glob-all).

* `options`

  * `options.dry` - A boolean indicating whether just to tell what would have been done instead of doing it. Default is `false`.

  * `options.verbose` - Adds some console.log() statements. Default is `false`.

## License

UNLICENSED