id = "eyed3"
name = "eyeD3"
homepage = "https://eyed3.readthedocs.io/"
description = "A Python tool for working with audio files, specifically MP3 files containing ID3 metadata"
executables = ["eyeD3", "eyed3"]

[dotfiles]

# eyeD3's official CLI documentation names ~/.eyeD3/config.ini as the
# optional default user configuration file.
# https://eyed3.readthedocs.io/en/v0.9.8/cli.html
paths = ["~/.eyeD3/config.ini"]
secret = []

[commands]
format = 1
label = "Show or edit audio tags"
description = "Display or set common ID3 tags (artist, album, title, track, genre, year) on audio files. Frames, images, lyrics, renaming and version conversion are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "man"
kind = "manual"
url = "https://manpages.debian.org/bookworm/eyed3/eyeD3.1.en.html"
revision = "bookworm"
evidence = """
  -Q, --quiet
  --backup
  -a STRING,
    --artist=STRING
  -A STRING,
    --album=STRING
  -b STRING,
    --album-artist=STRING
  -t STRING,
    --title=STRING
  -n NUM,
    --track=NUM
  -N NUM,
    --track-total=NUM
  -G GENRE,
    --genre=GENRE
  -Y YEAR,
    --release-year=YEAR
  -c STRING,
    --comment=STRING
  --remove-all-images
  --remove-all
  --remove-v1
  --remove-v2
"""

[[commands.field]]
id = "files"
label = "Audio files or directories"
type = "path"
position = 0
multiple = true
min = 1
path = { kind = "any", role = "input", must_exist = true }
sources = ["man"]

[[commands.field]]
id = "artist"
label = "Artist"
type = "string"
option = ["--artist", "-a"]
sources = ["man"]

[[commands.field]]
id = "album"
label = "Album"
type = "string"
option = ["--album", "-A"]
sources = ["man"]

[[commands.field]]
id = "album_artist"
label = "Album artist"
type = "string"
option = ["--album-artist", "-b"]
sources = ["man"]

[[commands.field]]
id = "title"
label = "Title"
type = "string"
option = ["--title", "-t"]
sources = ["man"]

[[commands.field]]
id = "track"
label = "Track number"
type = "integer"
option = ["--track", "-n"]
min = 0
sources = ["man"]

[[commands.field]]
id = "track_total"
label = "Total tracks"
type = "integer"
option = ["--track-total", "-N"]
min = 0
sources = ["man"]

[[commands.field]]
id = "genre"
label = "Genre"
type = "string"
option = ["--genre", "-G"]
sources = ["man"]

[[commands.field]]
id = "release_year"
label = "Release year"
type = "string"
option = ["--release-year", "-Y"]
sources = ["man"]

[[commands.field]]
id = "comment"
label = "Comment"
type = "string"
option = ["--comment", "-c"]
sources = ["man"]

[[commands.field]]
id = "backup"
label = "Back up files before editing"
type = "boolean"
option = ["--backup"]
sources = ["man"]

[[commands.field]]
id = "remove_all"
label = "Remove all tags"
description = "Removes every ID3 tag (v1 and v2) from the files."
type = "boolean"
option = ["--remove-all"]
effect = "delete"
sources = ["man"]

[[commands.field]]
id = "quiet"
label = "Quiet"
type = "boolean"
option = ["--quiet", "-Q"]
sources = ["man"]

[[commands.task]]
id = "show"
label = "Show tags"
fields = ["files"]
required = ["files"]

[[commands.task]]
id = "edit"
label = "Edit common tags"
fields = ["files", "artist", "album", "title", "track", "genre", "release_year", "backup"]
required = ["files"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["files", "artist", "album", "album_artist", "title", "track", "track_total", "genre", "release_year"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["comment", "backup", "remove_all", "quiet"]