Documentation

Basic usage

When you've installed omnitagger you can simply go to a directory where you have your audio files and run the omnitagger command. I'd suggest you read the How it works on the wiki to learn how omnitagger goes through the whole process.

$ omnitagger --help
usage: omnitagger [-h] [-e EXCEPTIONS [EXCEPTIONS ...]] [-r] [-c]
                  [-f FILETYPES [FILETYPES ...]] [-d] [-t] [-l]
                  [-i IGNORE_FILES [IGNORE_FILES ...]] [-s]

optional arguments:
  -h, --help            show this help message and exit
  -e EXCEPTIONS [EXCEPTIONS ...], --exceptions EXCEPTIONS [EXCEPTIONS ...]
                        Enter full artist or file names that you do not want
                        to be title cased
  -r, --recursive       Grab files recursively
  -c, --clear           Clear all existing metadata on all files before
                        inserting new ones
  -f FILETYPES [FILETYPES ...], --filetypes FILETYPES [FILETYPES ...]
                        Enter filetype(s) the script should only look for
                        (.mp3/.flac/.ogg)
  -d, --remove-original
                        Removes the original file after running
  -t, --titlecase-articles
                        Titlecase articles such as: a, an, and, as, that etc..
  -l, --fingerprint-lookup
                        Enable fingerprint lookup for files (much longer
                        process)
  -i IGNORE_FILES [IGNORE_FILES ...], --ignore-files IGNORE_FILES [IGNORE_FILES ...]
                        Specify the files you want omnitagger to ignore
                        completely
  -s, --skip-beautifying
                        If your files are already correct, omnitagger wil not
                        beautify them

-e, --exceptions

I haven't test it, but I know it will remove the "3" in e.g. "3 Doors Down". Let's say you have that as an artist and you don't want that "3" to be removed. You can run omnitagger with an exception for "3 Doors Down" (case sensitive!).

Simply run e.g.: $ omnitagger -e "3 Doors Down"

Another good example would be ACDC - TNT.mp3. You want both the artist and title to be as it is; untouched.

Simply run: $ omnitagger -e "ACDC" "TNT" The output will still be: ACDC - TNT.mp3.

-r, --recursive

Lets omnitagger grab files recursively (self-explaining).

-c, --clear

When omnitagger is about to write the metadata and the user passed the -c or --clear flag it will first clear all the metadata that's in the audio file (if it exists) before writing the new metadata.

-f, --filetypes

Omnitagger accepts mp3 ogg flac flac files only for now. It will looks for all 3 extensions on default. Let's say you only want the flac files to be taken. Simply run:

$ omnitagger -f flac

Or maybe you want flac and mp3 files. Simply run:

$ omnitagger -f flac mp3

-d, --remove-original

Will remove the original file after running.

-t, --titlecase-articles

On default omnitagger will not titlecase articles within the filename. For example:

01)_FOx____sTeVENsoN- CHECK THAT, a trIGgeR.mp3
will result in
Fox stevenson - Check That, a Trigger.mp3

Using the --titlecase-articles flag:
01)_FOx____sTeVENsoN- CHECK THAT, a trIGgeR.mp3
will result in
Fox stevenson - Check That, A Trigger.mp3

-l, --fingerprint-lookup

Omnitagger also enables fingerprint lookup. It passes the file to acoustid which checks for the fingerprint within the file. This is the best possible way to gather metadata. Although .. sometimes it returns a filename format you really don't want. For example: Artist - Title (Acoustic Version).mp3 while the audio file is not at all an acoustic version. Unfortunately we can't do anything about this. This is up to the webservice, acoustid, but it does a great job in general.

-i, --ignore-files

If you have files you literally don't want to be fully ignored up by omnitagger, then do e.g. this:

$ ls
Sia - Chandelier.mp3
Apek Ft. Liney - Voices.mp3
ACDC - TNT.mp3
ACDC - Thunderstruck.mp3
Slayer - Flesh Storm.mp3
Slayer - Angel of Death.mp3

$ omnitagger --skip "ACDC - *" "Slayer - Flesh Storm.mp3"

The following files will be ignored:
ACDC - TNT.mp3
ACDC - Thunderstruck.mp3
Slayer - Flesh Storm.mp3

-s, --skip-beautifying

If you have files that are, for you personally, already correct, then omnitagger won't beautify them. Note that it will still remove track numbers in front of the filename and remove extra whitespaces.