@kud/qobuz-cli 0.6.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -2
- package/dist/index.js +1338 -203
- package/package.json +11 -4
package/README.md
CHANGED
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
|
|
13
13
|
## Features
|
|
14
14
|
|
|
15
|
+
- **Interactive TUI** — full-screen terminal UI (Ink/React): type to search, arrow-key navigate, drill into detail, act. Launched with bare `qobuz` or `qobuz tui`. Works on macOS and Linux.
|
|
15
16
|
- **Fast search & metadata** — search albums, tracks, and artists; inspect album, artist, and track details.
|
|
16
17
|
- **Library & playlists** — list, add, and remove favourites; list, show, create, and edit playlists.
|
|
17
18
|
- **Collection stats** — `qobuz stats` shows your genre mix, hi-res ratio, and top artists/labels from the local desktop library.
|
|
@@ -25,9 +26,44 @@
|
|
|
25
26
|
npm install -g @kud/qobuz-cli
|
|
26
27
|
```
|
|
27
28
|
|
|
29
|
+
## TUI mode
|
|
30
|
+
|
|
31
|
+
Run `qobuz` (no arguments) or `qobuz tui` to open the interactive full-screen interface — "Raycast in the terminal". The TUI requires an interactive terminal (TTY) and works on both macOS and Linux.
|
|
32
|
+
|
|
33
|
+
### Views
|
|
34
|
+
|
|
35
|
+
| View | What it shows |
|
|
36
|
+
| ------------------- | -------------------------------------------------------------------------- |
|
|
37
|
+
| **Home** | Palette — Search, Favourites, Playlists, Now Playing |
|
|
38
|
+
| **Search** | Live results sectioned into Tracks, Albums, Artists (debounced, ≥ 2 chars) |
|
|
39
|
+
| **Favourites** | Your starred tracks |
|
|
40
|
+
| **Playlists** | Playlist list → Tracklist (read-only) |
|
|
41
|
+
| **Detail — Track** | Title, artist, album, duration, Hi-Res flag |
|
|
42
|
+
| **Detail — Album** | Title, artist, release date, genre, track count, Hi-Res flag |
|
|
43
|
+
| **Detail — Artist** | Album count + navigable similar-artists list |
|
|
44
|
+
| **Convert** | Qobuz track → Deezer / Spotify / YouTube links |
|
|
45
|
+
| **Now Playing** | Currently playing track info |
|
|
46
|
+
|
|
47
|
+
### Keybindings
|
|
48
|
+
|
|
49
|
+
| Key | Action |
|
|
50
|
+
| ---------------------- | ----------------------------------------------- |
|
|
51
|
+
| type | Search (in Search view) |
|
|
52
|
+
| `↑` / `↓` or `j` / `k` | Navigate list |
|
|
53
|
+
| `↵` | Open / drill into item |
|
|
54
|
+
| `Esc` or `Backspace` | Back (quit from root) |
|
|
55
|
+
| `q` | Quit |
|
|
56
|
+
| `o` | Open current item in Qobuz app (Detail views) |
|
|
57
|
+
| `c` | Convert track to streaming links (Track detail) |
|
|
58
|
+
| `space` | Toggle play/pause (macOS only) |
|
|
59
|
+
| `n` | Next track (macOS only) |
|
|
60
|
+
| `p` | Previous track (macOS only) |
|
|
61
|
+
|
|
28
62
|
## Usage
|
|
29
63
|
|
|
30
64
|
```console
|
|
65
|
+
$ qobuz # open interactive TUI
|
|
66
|
+
$ qobuz tui # same — explicit subcommand
|
|
31
67
|
$ qobuz login # connect (opens browser, paste app_id + token)
|
|
32
68
|
$ qobuz search "radiohead"
|
|
33
69
|
$ qobuz album 0634904032432
|
|
@@ -40,11 +76,13 @@ $ qobuz open album 0634904032432 # open in the Qobuz app
|
|
|
40
76
|
$ qobuz url # copy the currently-playing track's link
|
|
41
77
|
$ qobuz url album 0634904032432 # copy a specific item's deep link
|
|
42
78
|
$ qobuz url --plain # print the bare URL (no clipboard) for scripting
|
|
79
|
+
$ qobuz convert <track-url> # convert a Qobuz track URL to streaming links
|
|
80
|
+
$ qobuz now-playing # show the currently-playing track (alias: np)
|
|
43
81
|
```
|
|
44
82
|
|
|
45
|
-
Full command set: `login`, `logout`, `search`, `album`, `artist`, `track`, `similar`, `fav` (list/add/remove), `playlist` (list/show/create/add/remove), `stats`, `url` / `copy-url`, `open`, `play`, `next`, `previous` / `prev`, `forward` / `ff`, `rewind` / `rew`.
|
|
83
|
+
Full command set: `tui`, `login`, `logout`, `search`, `album`, `artist`, `track`, `similar`, `fav` (list/add/remove), `playlist` (list/show/create/add/remove), `convert`, `now-playing` / `np`, `stats`, `url` / `copy-url`, `open`, `play`, `next`, `previous` / `prev`, `forward` / `ff`, `rewind` / `rew`.
|
|
46
84
|
|
|
47
|
-
> **macOS note** — playback commands (`play`, `next`, `previous`, `forward`, `rewind`) use real media keys and require Accessibility permission granted to your terminal. The first playback command compiles a small Swift helper via `swiftc`.
|
|
85
|
+
> **macOS note** — playback commands (`play`, `next`, `previous`, `forward`, `rewind`) and TUI playback keys (`space`, `n`, `p`) use real media keys and require Accessibility permission granted to your terminal. The first playback command compiles a small Swift helper via `swiftc`.
|
|
48
86
|
|
|
49
87
|
## Development
|
|
50
88
|
|
|
@@ -53,6 +91,7 @@ git clone https://github.com/kud/qobuz-cli.git
|
|
|
53
91
|
cd qobuz-cli
|
|
54
92
|
npm install
|
|
55
93
|
npm run dev -- search "radiohead" # run from source via tsx
|
|
94
|
+
npm run dev # run TUI from source
|
|
56
95
|
npm run build
|
|
57
96
|
npm run typecheck
|
|
58
97
|
```
|