https://github.com/go-musicfox/spotifox
Spotifox is yet another spotify CLI client similar to go-musicfox
https://github.com/go-musicfox/spotifox
go go-musicfox music musicfox spotifox spotify spotify-cli spotify-client spotify-tui tui
Last synced: 10 months ago
JSON representation
Spotifox is yet another spotify CLI client similar to go-musicfox
- Host: GitHub
- URL: https://github.com/go-musicfox/spotifox
- Owner: go-musicfox
- License: mit
- Created: 2023-08-31T13:09:20.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-13T05:31:42.000Z (over 1 year ago)
- Last Synced: 2024-12-13T06:26:54.129Z (over 1 year ago)
- Topics: go, go-musicfox, music, musicfox, spotifox, spotify, spotify-cli, spotify-client, spotify-tui, tui
- Language: Go
- Homepage:
- Size: 22.3 MB
- Stars: 79
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spotifox
English | [简体中文](./README_CN.md)
Spotifox is yet another spotify CLI client similar to [go-musicfox](https://github.com/go-musicfox/go-musicfox).
> UI base on [charmbracelet/bubbletea](https://github.com/charmbracelet/bubbletea)
    
 
([The icon](https://github.com/go-musicfox/go-musicfox-icon) is based on [kitty-icon](https://github.com/DinkDonk/kitty-icon))
------------------------------
## Preview
#### 1. Startup
#### 2. MainUI
#### 3. Notification
#### 4. Login
#### 5. Search
#### 6. macOS NowPlaying
## Install
### macOS
#### 1. Homebrew
```sh
$ brew install go-musicfox/go-musicfox/spotifox
```
#### 2. Binary
Download binary file => [Release](https://github.com/go-musicfox/spotifox/releases/latest)
### Linux
#### 1. Use Distro Package (Recommend)
##### Arch Linux
###### Install From [AUR](https://aur.archlinux.org/)
```sh
$ paru -S spotifox-bin # Download and install the precompiled binary file
```
#### 2. Homebrew
```sh
$ brew install go-musicfox/go-musicfox/spotifox
```
#### 3. Binary
Download binary file => [Release](https://github.com/go-musicfox/spotifox/releases/latest)
### Windows
#### 1. Scoop
```sh
scoop bucket add spotifox https://github.com/go-musicfox/spotifox.git
scoop install spotifox
```
#### 2. Binary
Download binary file => [Release](https://github.com/go-musicfox/spotifox/releases/latest)
### Manual Build
```sh
$ git clone https://github.com/go-musicfox/spotifox
$ go mod download
$ make
$ make install
```
## Usage
```sh
$ spotifox
```
### Notice
- **Please be sure to use a fixed width font or set the configuration item `dualColumn` to `false`, otherwise the dual column display layout may be confusing**
### Shortcut keys
| Key | Effect | Remark |
|:----------------:|:----------------------------------:|:------------:|
| `h`/`H`/`←` | Move left | |
| `l`/`L`/`→` | Move right | |
| `k`/`K`/`↑` | Move up | |
| `j`/`J`/`↓` | Move down | |
| `g` | Move to top | |
| `G` | Move to bottom | |
| `q`/`Q` | Quit | |
| `Space` | Paly/Pause | |
| `[` | Pre song | |
| `]` | Next song | |
| `-` | Down volume | |
| `=` | Up volume | |
| `n`/`N`/`Enter` | Enter menu | |
| `b`/`B`/`Escape` | Back | |
| `w`/`W` | Logout and quit | |
| `p` | Switch play mode | |
| `r`/`R` | Rerender UI | |
| `c`/`C` | Current Playlist | |
| `,` | Like playing song | |
| `<` | Like selected song | |
| `.` | Dislike playing song | |
| `>` | Dislike selected song | |
| `` ` `` | Add playing song to playlist | |
| `~` | Remove playing song from playlist | |
| `Tab` | Add selected song to playlist | |
| `Shift+Tab` | Remove selected song from playlist | |
| `/` | Search current menu list | |
| `?` | Help | |
| `a` | Album of playing song | |
| `A` | Album of selected song | |
| `s` | Artist of playing song | |
| `S` | Artist of selected song | |
| `o` | Open playing song in brownser | |
| `O` | Open selected item in brownser | |
| `;`/`:` | Follow selected playlist | |
| `'`/`"` | Unfollow selected playlist | |
## Configuration
Configuration file path:
```shell
spotifox config
```
> Set environment variables(`SPOTIFOX_ROOT`) to change the configuration file path
[Sample](./utils/embed/spotifox.ini)
## Similar Projects
* [go-musicfox/go-musicfox](https://github.com/go-musicfox/go-musicfox)
## Donate
## Thanks
Thanks to the following projects and their contributors (but not limited to):
* [bubbletea](https://github.com/charmbracelet/bubbletea)
* [beep](https://github.com/faiface/beep)
* [musicbox](https://github.com/darknessomi/musicbox)
* [gcli](https://github.com/gookit/gcli)
* ...
[](https://star-history.com/#go-musicfox/spotifox&Date)