glyrc(1)

πŸŽ€ NAME πŸŽ€

glyrc β€” okay so picture this: it's a search engine for music-related metadata πŸ’– like, covers, lyrics, artist pics, the whole vibe. And yes bestie, this is the glyrc(1) page straight out of the General Commands Manual, we are being official today ✨


πŸ¦‹ USAGE πŸ¦‹

glyrc GETTER [options]

where GETTER must be one of these lil guys (pick exactly one, no mixing and matching πŸ‘‘):

  • cover
  • lyrics
  • artistphoto
  • artistbio
  • similarartists
  • similarsongs
  • albumreview
  • albumlist
  • tags
  • relations
  • tracklist
  • guitartabs
  • backdrops

✨ GENERAL OPTIONS ✨

  • -f, --from String β€” which providers you wanna pull metadata from πŸ’… run glyrc --list and it'll show you the full lineup, no cap.
  • -w, --write Path β€” writes the metadata to the dir d, or to the filename d. The special values stdout, stderr and null are supported too 🌈

And here's the cute part: certain escapes get escaped inside the filename in the form :X:, where X can be any of these:

  • type : The getter used in this query (e.g. cover)
  • artist : Artist - as passed by -a
  • album : Album - as passed by -b
  • title : Title - as passed by -t
  • size : Size in bytes
  • format : The image format or txt for textitems
  • source : The source URL of this item
  • prov : The Provider of this item
  • cksum : a md5sum of the data
  • rating : (Usually 0)
  • duration : (Only for tracks) Duration in seconds
  • number : An index incremented with each item (starting with 1)

The default format is ':artist::album::title::type::number:.:format:' πŸŽ€ Strings containing / are replaced with | automatically, so --write ':artist:' for AC/DC will result in AC|DC β€” the filesystem said absolutely not to that slash, periodt.

  • -n, --number Integer β€” download max. n items. Fair warning bestie: the amount of actually downloaded items may be less. She's aspirational like that 😭
  • -l, --lang String β€” language settings. Only a few getters actually use this to deliver localized data. Given in ISO 639-1 codes like de 🌸
  • -o, --only-lang β€” only use providers that offer language specific data. Heads up: this only applies to text items.
  • -z, --fuzzyness Integer β€” sets the threshold for the level of the Levenshtein algorithm. Yes that's a real word, yes it's doing math about how "close enough" a match is πŸ”₯
  • -q, --qsratio Float β€” how to weight quality/speed; 1.0 = full quality, 0.0 = full speed. Pick your fighter ⚑
  • -x, --plugmax Integer β€” the maximum number a download plugin may deliver. Use this to make results more varied πŸ’«
  • -v, --verbosity Integer β€” set verbosity from 0 to 4. See the online README for the details, iykyk.

🌐 NETWORK OPTIONS 🌐

  • -p, --parallel Integer β€” define the number of downloads that may be performed in parallel. Multitasking queen πŸ‘‘
  • -u, --useragent String β€” the useragent to use during HTTP requests.
  • -r, --redirects Integer β€” define the number of redirects that are allowed. She will follow, but only so far πŸ™ˆ
  • -m, --timeout Integer β€” define the maximum number in seconds after which a download is cancelled ⏰
  • -k, --proxy String β€” set the proxy to use, in the form of:
[protocol://][user:pass@]yourproxy.domain[:port]

πŸ’… PROVIDER SPECIFIC OPTIONS πŸ’…

  • -d, --download β€” download Images. Yes, capital-I Images, we respect her.
  • -D, --skip-download β€” don't download images, but return the URLs to them (acts like a search engine). Honestly iconic behaviour πŸ”
  • -a, --artist String β€” artist name to search for.
  • -b, --album String β€” album name to search for.
  • -t, --title String β€” songname to search for.
  • -e, --maxsize Integer β€” (images only) the maximum size a cover may have.
  • -i, --minsize Integer β€” (images only) the minimum size a cover may have.
  • -F, --formats String β€” a semicolon separated list of imageformats that are allowed. e.g.: png;jpeg πŸ–ΌοΈ
  • -8, --force-utf8 β€” forces utf8 encoding for text items, invalid encodings get sorted out ✨

πŸ“ MISC OPTIONS πŸ“

  • -L, --list β€” list all fetchers and source providers for each and exit. Window shopping, but make it metadata.
  • -h, --help β€” this text you unlucky wanderer are viewing 😭 (yes, that's literally what it says, and honestly? relatable.)
  • -V, --version β€” print the version string.
  • -U, --update β€” updates libglyr if a new version is available. Staying fresh πŸ’–
  • -g, --as-one β€” (Textitems only) output all results as one. Super useful for tracklist and albumlist.
  • -G, --no-as-one β€” disables --as-one (Default).
  • -y, --color β€” enables colored output for glyrc (Default). As she should 🌈
  • -Y, --no-color β€” prints no colored output.
  • -s, --musictree-path p β€” p is a path to your music directory. Glyr might fetch things like folger.jpg from there πŸ‘€
  • -j, --callback Command β€” set a bash command to be executed when an item is finished downloading. The special string <path> is expanded with the actual path to the data πŸ”₯

πŸ’Ύ DATABASE OPTIONS πŸ’Ύ

  • -c, --cache folder β€” creates or opens an existing cache at folder/metadata.db and lookups data from there. Bestie is keeping receipts πŸ“
  • cache select [Query] β€” selects data from the cache; you can use any other option behind this.
  • cache delete [Query] β€” instead of searching for this element, the element is deleted from the database. Needs --cache. Gone, reduced to atoms πŸ’€
  • cache list β€” list all items in the database (including the artist / album / title / type). Needs --cache.

🌟 EXAMPLES 🌟

glyrc cover --artist SomeBand --album SomeAlbum

DB:

# Write found items to cache; create it if not existent
glyrc lyrics -a A -b B --cache /tmp

# List all in the cache
glyrc cache list --cache /tmp

# Delete artist/album
glyrc cache delete cover -a Equilibrium -b Sagas --cache /tmp

# Search for two items in cache and print them
glyrc cache select lyrics -a Knorkator -t 'A' -n 2 --cache /tmp
With each item received you get a link to the original source, please refer to the individual terms of use β€” copying and distributing of this data might be not allowed 🚨 fr fr, read the terms.

A more detailed version of this help can be found online: https://github.com/sahib/glyr/wiki/Commandline-arguments 🧚


πŸ‘‘ AUTHORS πŸ‘‘

Christopher Pahl <sahib@online.de>, Etienne Millon.


and that's the whole page bestie πŸ’– this one shipped as part of the General Commands Manual, dated May 9 2012, and it answers to the name glyrc(1). go forth and fetch metadata, you absolute main character πŸŽ€βœ¨πŸ¦‹