finish renaming
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# lrcfetch
|
||||
# LRX-CLI
|
||||
|
||||
A CLI tool for fetching LRC lyrics on Linux. Automatically detects the currently playing track via MPRIS/DBus and retrieves synced (or plain with all time tags set to `[00:00.00]` if failed to find any synced) lyrics from multiple sources.
|
||||
|
||||
@@ -16,76 +16,76 @@ Lyrics are fetched using a fallback pipeline (first synced result wins):
|
||||
|
||||
## Usage
|
||||
|
||||
See `lrcfetch --help` for full command reference. Common use cases:
|
||||
See `lrx --help` for full command reference. Common use cases:
|
||||
|
||||
- Fetch lyrics for the currently playing track:
|
||||
|
||||
```bash
|
||||
lrcfetch fetch
|
||||
lrx fetch
|
||||
```
|
||||
|
||||
using a specific player or source to fetch from:
|
||||
|
||||
```bash
|
||||
lrcfetch --player mpd fetch --method lrclib-search
|
||||
lrx --player mpd fetch --method lrclib-search
|
||||
```
|
||||
|
||||
- Search by metadata (bypasses MPRIS):
|
||||
|
||||
```bash
|
||||
lrcfetch search -t "My Love" -a "Westlife"
|
||||
lrcfetch search --trackid "5p0ietGkLNEqx1Z7ijkw5g"
|
||||
lrx search -t "My Love" -a "Westlife"
|
||||
lrx search --trackid "5p0ietGkLNEqx1Z7ijkw5g"
|
||||
```
|
||||
|
||||
or for a local file:
|
||||
|
||||
```bash
|
||||
lrcfetch search --path "/path/to/Westlife - My Love.flac"
|
||||
lrx search --path "/path/to/Westlife - My Love.flac"
|
||||
```
|
||||
|
||||
- Export to sidecar `.lrc` file:
|
||||
|
||||
```bash
|
||||
lrcfetch export
|
||||
lrx export
|
||||
```
|
||||
|
||||
or to a custom path:
|
||||
|
||||
```bash
|
||||
lrcfetch export --output /path/to/lyrics.lrc
|
||||
lrx export --output /path/to/lyrics.lrc
|
||||
```
|
||||
|
||||
- Cache management:
|
||||
|
||||
```bash
|
||||
lrcfetch cache stats # show cache statistics
|
||||
lrcfetch cache query # query cache for current track
|
||||
lrcfetch cache clear # clears cache of current track
|
||||
lrcfetch cache clear --all # clears entire cache
|
||||
lrx cache stats # show cache statistics
|
||||
lrx cache query # query cache for current track
|
||||
lrx cache clear # clears cache of current track
|
||||
lrx cache clear --all # clears entire cache
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
Set credentials via environment variable or `.env` file:
|
||||
|
||||
- `~/.config/lrcfetch/.env` — user-level
|
||||
- `~/.config/lrx/.env` — user-level
|
||||
- `.env` in working directory — project-local
|
||||
- Shell environment — highest priority
|
||||
|
||||
```env
|
||||
SPOTIFY_SP_DC=your_cookie_value
|
||||
QQ_MUSIC_API_URL=https://api.example.com
|
||||
LRCFETCH_PLAYER=spotify
|
||||
PREFERRED_PLAYER=spotify
|
||||
```
|
||||
|
||||
- `SPOTIFY_SP_DC` — required for Spotify source. Defaults to empty (disabled Spotify source).
|
||||
- `QQ_MUSIC_API_URL` — required for QQ Music source. Defaults to empty (disabled QQ Music source).
|
||||
- `LRCFETCH_PLAYER` — preferred MPRIS player when multiple are active. Defaults to `spotify`. Only used when no `--player` flag is given and more than one player (or none of them) is currently playing.
|
||||
- `PREFERRED_PLAYER` — preferred MPRIS player when multiple are active. Defaults to `spotify`. Only used when no `--player` flag is given and more than one player (or none of them) is currently playing.
|
||||
|
||||
Shell completion (zsh/fish/bash):
|
||||
|
||||
```bash
|
||||
lrcfetch --install-completion
|
||||
lrx --install-completion
|
||||
```
|
||||
|
||||
## Credits
|
||||
|
||||
Reference in New Issue
Block a user