git.r.bdr.sh - rbdr/r.bdr.sh/blob - lyricli.gmi

   1 --- title: /lyricli.html
   2 --- description: "Lyricli (lrc), a command line lyrics finder for linux and mac"
   3 ## lyricli (lrc)
   4
   5 Command line tool that shows lyrics for your currently playing song in the terminal, supports spotify and apple music on macos, and most linux music players.
   6
   7 => https://git.r.bdr.sh/rbdr/lyricli view source (git.r.bdr.sh)
   8 => https://git.sr.ht/~rbdr/lyricli view source (sourcehut mirror)
   9
  10 ## Install
  11
  12 ### Homebrew
  13 You can install using homebrew. For direct binaries see below.
  14
  15 ```
  16 $ brew tap rbdr/apps git@git.sr.ht:~rbdr/homebrew-apps
  17 $ brew install lyricli
  18 ```
  19
  20 ### Prebuilt Packages
  21 You can find pre-built packages for linux @ build.r.bdr.sh. There you can
  22 find a `.tar.gz` that includes only the binary, or `.rpm` and `.deb`
  23 distributions for fedora and debian that include a manpage.
  24
  25 Binaries are provided for x86_64 and aarch64.
  26
  27 Unstable releases are built directly from the main branch, while tagged
  28 versions have their own release and can be considered more stable.
  29
  30 => gemini://build.r.bdr.sh/lyricli lyricli pre-built releases @ gemini
  31 => https://build.r.bdr.sh/lyricli lyricli pre-built releases @ https
  32
  33 ### From Source
  34
  35 In order to build this project, you'll need a genius client token. See the genius api docs for more information.
  36
  37 => https://docs.genius.com/ genius api docs
  38
  39 Make sure you have rust and Make installed. Clone the repository, and run:
  40
  41 ```
  42 % make -e profile=release
  43 ```
  44
  45 Then copy the file somewhere in your PATH
  46
  47 ```
  48 % cp ./target/release/lyricli /usr/local/lyricli
  49 ```
  50
  51 ## Usage
  52 Running without arguments will try to detect your current song in apple music or spotify
  53
  54 You can run it with artist name and song name to fetch it manually
  55
  56 ```
  57 $ lrc artist_name song_name
  58 ```
  59
  60 You can view help with the h / help flag
  61
  62 ```
  63 $ lrc -h
  64 $ lrc --help
  65 ```
  66
  67 ## Managing Sources
  68
  69 By default it comes with spotify and apple music sources enabled, you can disable sources using:
  70
  71 ```
  72 $ lrc -d (source_name)
  73 $ lrc --disable-source (source_name)
  74 ```
  75
  76 You can enable the source again using
  77
  78 ```
  79 $ lrc -e (source_name)
  80 $ lrc --enable-source (source_name)
  81 ```
  82
  83 You can list all the sources with:
  84
  85 ```
  86 $ lrc -l
  87 $ lrc --list-sources
  88 ```
  89
  90 ## Changelog
  91
  92 * 3.0.0 Rewritten in rust, supports linux media players. Relicensed to AGPL 3.0
  93 * 2.0.1 Fixes a segfault when there are no results, and incorrect behavior when results are not songs.
  94 * 2.0.0 Upgraded for swift 5.8 and work with the genius API instead of defunct LyricsWiki.
  95 * 1.0.0 Upgraded for swift 5.0. Gets rid of the arguments source. Adds Apple Music support and ensures the app is running.
  96 * 0.3.0 Spotify support. Bugfixes for iTunes support when app is not running.
  97 * 0.2.0 iTunes support. Bugfixes for iTunes support when app is not running.
  98 * 0.1.0 Initial swift release. Relicense to Apache. Only arguments source.
  99 * 0.0.2 Improves error management and source management. Adds iTunes source.
 100 * 0.0.1 Initial release in ruby with rdio support.
 101
 102 ### Older Releases
 103
 104 You can download binaries of older releases, macos only.
 105
 106 2.0.1
 107 => /files/lyricli/lrc-2.0.1-universal.tar.gz lrc 2.0.1 (universal)
 108 => /files/lyricli/lrc-2.0.1-arm64.tar.gz lrc 2.0.1 (arm64)
 109 => /files/lyricli/lrc-2.0.1-x86_64.tar.gz lrc 2.0.1 (x86_64)
 110
 111 2.0.0
 112 => /files/lyricli/lrc-2.0.0-universal.tar.gz lrc 2.0.0 (universal)
 113 => /files/lyricli/lrc-2.0.0-arm64.tar.gz lrc 2.0.0 (arm64)
 114 => /files/lyricli/lrc-2.0.0-x86_64.tar.gz lrc 2.0.0 (x86_64)