]> git.r.bdr.sh - rbdr/r.bdr.sh/blame_incremental - lyricli.gmi
Simplify reduce motion check
[rbdr/r.bdr.sh] / lyricli.gmi
... / ...
CommitLineData
1--- title: /lyricli.html
2--- description: "Lyricli (lrc), a command line lyrics finder for linux and mac"
3## lyricli (lrc)
4
5Command 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
13You 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
21You can find pre-built packages for linux @ build.r.bdr.sh. There you can
22find a `.tar.gz` that includes only the binary, or `.rpm` and `.deb`
23distributions for fedora and debian that include a manpage.
24
25Binaries are provided for x86_64 and aarch64.
26
27Unstable releases are built directly from the main branch, while tagged
28versions 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
35In 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
39Make sure you have rust and Make installed. Clone the repository, and run:
40
41```
42% make -e profile=release
43```
44
45Then copy the file somewhere in your PATH
46
47```
48% cp ./target/release/lyricli /usr/local/lyricli
49```
50
51## Usage
52Running without arguments will try to detect your current song in apple music or spotify
53
54```
55$ lrc
56```
57
58You can run it with artist name and song name to fetch it manually
59
60```
61$ lrc artist_name song_name
62```
63
64You can view help with the h / help flag
65
66```
67$ lrc -h
68$ lrc --help
69```
70
71### Manual
72
73If you install using the rpm and deb you should be able to call help with man
74
75```
76man lrc
77```
78
79## Managing Sources
80
81By default it comes with spotify and apple music sources enabled, you can disable sources using:
82
83```
84$ lrc -d (source_name)
85$ lrc --disable-source (source_name)
86```
87
88You can enable the source again using
89
90```
91$ lrc -e (source_name)
92$ lrc --enable-source (source_name)
93```
94
95You can list all the sources with:
96
97```
98$ lrc -l
99$ lrc --list-sources
100```
101
102## Changelog
103
104* 3.0.0 Rewritten in rust, supports linux media players. Relicensed to AGPL 3.0
105* 2.0.1 Fixes a segfault when there are no results, and incorrect behavior when results are not songs.
106* 2.0.0 Upgraded for swift 5.8 and work with the genius API instead of defunct LyricsWiki.
107* 1.0.0 Upgraded for swift 5.0. Gets rid of the arguments source. Adds Apple Music support and ensures the app is running.
108* 0.3.0 Spotify support. Bugfixes for iTunes support when app is not running.
109* 0.2.0 iTunes support. Bugfixes for iTunes support when app is not running.
110* 0.1.0 Initial swift release. Relicense to Apache. Only arguments source.
111* 0.0.2 Improves error management and source management. Adds iTunes source.
112* 0.0.1 Initial release in ruby with rdio support.
113
114### Older Releases
115
116You can download binaries of older releases, macos only.
117
1182.0.1
119=> /files/lyricli/lrc-2.0.1-universal.tar.gz lrc 2.0.1 (universal)
120=> /files/lyricli/lrc-2.0.1-arm64.tar.gz lrc 2.0.1 (arm64)
121=> /files/lyricli/lrc-2.0.1-x86_64.tar.gz lrc 2.0.1 (x86_64)
122
1232.0.0
124=> /files/lyricli/lrc-2.0.0-universal.tar.gz lrc 2.0.0 (universal)
125=> /files/lyricli/lrc-2.0.0-arm64.tar.gz lrc 2.0.0 (arm64)
126=> /files/lyricli/lrc-2.0.0-x86_64.tar.gz lrc 2.0.0 (x86_64)