git.r.bdr.sh - rbdr/lyricli/blob - README.md

   1 # Lyricli (lrc)
   2
   3 A command line tool to show the lyrics of your current song.
   4
   5 ## Usage
   6
   7 Lyricli can be invoked with the command `lrc`.
   8
   9 ```
  10 $ lrc [-t]
  11 ```
  12
  13 When you run it without arguments, it will look in the available source
  14 to try to find a playing song and extract the lyrics. If you include the
  15 `-t` flag, it will show the song and artist names before the lyrics.
  16
  17 ```
  18 $ lrc [-t] <artist_name> <song_name>
  19 ```
  20
  21 When you run it with arguments, it will use them to search for the
  22 lyrics. This won't work if you manually disable the arguments source in
  23 your configuration file. If you include the `-t` flag, it will show the
  24 song and artist names before the lyrics.
  25
  26 ### Commands
  27
  28 In order to configure sources, lyricli provides a few commands:
  29
  30 * `lrc -l` or `lrc --list-sources` lists the available sources. Enabled
  31   sourcess will have a `*`
  32 * `lrc -e` or `lrc --enable-source <source>` enables a source
  33 * `lrc -d` or `lrc --disable-source <source>` disables a source without
  34   resetting its configuration.
  35 * `lrc -r` or `lrc --reset-source <source>` resets the configuration
  36   for a source and disables it.
  37
  38 And you can print the help or the version:
  39
  40 * `lrc -v` or `lrc --version` prints the version
  41 * `lrc -h` or `lrc --help` display built-in help
  42
  43 ## Building
  44
  45 In order to build this project, you'll need a genius client token. See
  46 the [genius api docs][genius_api_docs] for more information.
  47
  48 The Makefile will read the values from a `.env` file, so you can copy the
  49 `env.dist` file and fill the values there.
  50
  51 You can build for development just by running make. You can specify the
  52 profile using the profile environment value `-e profile=release`.
  53
  54 ```
  55 # Build for dev
  56 make
  57
  58 # Build for release
  59 make -e profile=release
  60 ```
  61
  62 [genius_api_docs]: https://docs.genius.com/