aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: fb3b033e00a266d08b6e6422d0edcf542809e842 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# tag-tracks

Very simple command-line tool to tag mp3 files in a given directory.
It just numbers the tracks and puts the filename as the title.

Requires a directory as argument.

## Description

tag-tracks scans a directory of mp3 files and automatically assigns
track numbers in alphabetical order. It also sets the track title to
match the filename without extension.  
I mainly use this in conjunction with yt-dlp to organize my music
downloads.

## Installation

### Build and Install

Clone the repository and build the gem:

```bash
git clone https://git.cafebabe.gay/tag-tracks.git
cd tag-tracks
gem build tag-tracks.gemspec
gem install ./tag-tracks-1.0.0.gem
```

### Dependencies

The gem depends on `taglib-ruby`, which will be installed automatically.
However, you may need to install the TagLib C++ library first:

#### Gentoo

`# emerge -av media-libs/taglib`

#### Debian

`# apt-get install libtag1-dev`

#### Arch

`# pacman -S taglib`

## Usage

Run the command with a target directory containing mp3 files:

`tag-tracks /media/music`

### Example

```bash
$ ls /media/music
dont-stay.mp3
papercut.mp3
somewhere-i-belong.mp3

$ tag-tracks /media/music
Tagging Tracks in /media/music ...
Done!
```

The tool will:

- Set track numbers sequentially, in alphabetical order
- Set track titles based on filenames ("dont-stay", "papercut", "somewhere-i-belong")

## LICENSE

GPL-3.0 - This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.  
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.