Spotify TUI

用 Rust 编写的 Spotify 终端客户端。

上面的演示中使用的是 Rigel 主题。

• Spotify TUI
  • 安装
    • Homebrew
    • Snap
    • AUR
    • Nix
    • Void Linux
    • Fedora/CentOS
    • Cargo
      • Linux 注意事项
    • Windows
      • Scoop 安装程序
    • 手动
  • 连接到 Spotify 的 API
  • 用法
• 配置
  • 限制
  • 与 spotifyd 一起使用
  • 使用的库
  • 开发
    • Windows Linux 子系统
  • 贡献者
  • 路线图
    • 尚未实施的高级要求

安装

二进制可执行文件是 spt。

Homebrew

适用于 macOS 和 Linux

brew install spotify-tui

要更新，运行

brew upgrade spotify-tui

Snap

对于已安装 Snap 的系统，运行

snap install spt

将自动为您安装稳定版本。

如果您想安装夜间构建版本，运行

snap install spt --edge

AUR

对于使用 Arch Linux 的用户，您可以在 AUR 此处 找到该软件包。如果您使用 AUR 辅助程序，可以直接从中安装，例如（在 yay 的情况下），运行

yay -S spotify-tui

Nix

作为 spotify-tui 软件包提供。要安装，运行

nix-env -iA nixpkgs.spotify-tui

其中 nixpkgs 是您配置中的频道名称。要获得更最新的安装，请使用不稳定频道。还可以将软件包添加到 environment.systemPackages（对于 NixOS），或当使用 home-manager 时，添加到 home.packages。

Void Linux

可在官方仓库中找到。要安装，运行

sudo xbps-install -Su spotify-tui

Fedora/CentOS

可在 Copr 仓库中找到。要安装，运行

sudo dnf copr enable atim/spotify-tui -y && sudo dnf install spotify-tui

Cargo

如果您的架构不支持在 发布页面 上找到的预构建二进制文件，请使用此选项。

首先，安装 Rust（使用推荐的 rustup 安装方法），然后

cargo install spotify-tui

此方法将从源代码构建二进制文件。

要更新，再次运行相同的命令。

Linux 注意事项

在Linux上进行编译时，需要安装libssl的开发包。有关基本安装说明，请参阅安装OpenSSL。为了定位依赖项，编译还需要安装pkg-config。

如果你正在使用Windows Subsystem for Linux，则需要安装其他依赖项。

Windows 10

Scoop 安装程序

首先，确保scoop安装程序在你的Windows机器上，有关说明请访问scoop.sh

然后打开powershell并运行以下两个命令

scoop bucket add scoop-bucket https://github.com/Rigellute/scoop-bucket
scoop install spotify-tui

之后程序将以： spt 或 spt.exe 的形式可用

手动

1. 下载适用于您操作系统的最新二进制文件。
2. cd 到你刚刚下载的文件并解压
3. cd 到 spotify-tui 并使用 ./spt 运行

连接到 Spotify 的 API

spotify-tui 需要连接到Spotify的API，以便通过名称查找音乐，播放曲目等。

首次运行应用程序时，将显示如何设置此功能的说明。

但它们又来了

1. 前往Spotify仪表板
2. 点击 创建应用
   • 现在你可以看到你的 客户端ID 和 客户端密钥
3. 现在点击 编辑设置
4. 将 https://127.0.0.1:8888/callback 添加到重定向URI
5. 向下滚动并点击 保存
6. 你现在可以认证Spotify了！
7. 回到终端
8. 运行 spt
9. 输入你的 客户端ID
10. 输入你的 客户端密钥
11. 按Enter确认默认端口（8888）或输入自定义端口
12. 你将被重定向到一个官方的Spotify网页，要求你给予权限。
13. 接受权限后，你将被重定向到localhost。如果一切顺利，重定向URL将被自动解析，现在你已经完成了。如果由于某种原因本地Web服务器失败，你将被重定向到一个空白网页，可能会说“连接拒绝”，因为没有服务器正在运行。无论如何，复制URL并将其粘贴到终端中的提示符。

现在你就可以使用spotify-tui了 🎉

您可以在${HOME}/.config/spotify-tui/client.yml中随时编辑配置。（对于snap ${HOME}/snap/spt/current/.config/spotify-tui/client.yml）

用法

二进制文件名为 spt。

不使用参数运行 spt 将显示UI。按 ? 显示帮助菜单，显示当前实现的关键事件及其操作。还有一个CLI可以执行UI的大部分操作。使用 spt --help 了解更多。

这里有一些示例来让你兴奋。

spt --completions zsh # Prints shell completions for zsh to stdout (bash, power-shell and more are supported)

spt play --name "Your Playlist" --playlist --random # Plays a random song from "Your Playlist"
spt play --name "A cool song" --track # Plays 'A cool song'

spt playback --like --shuffle # Likes the current song and toggles shuffle mode
spt playback --toggle # Plays/pauses the current playback

spt list --liked --limit 50 # See your liked songs (50 is the max limit)

# Looks for 'An even cooler song' and gives you the '{name} from {album}' of up to 30 matches
spt search "An even cooler song" --tracks --format "%t from %b" --limit 30

配置

配置文件位于 ${HOME}/.config/spotify-tui/config.yml，对于 snap ${HOME}/snap/spt/current/.config/spotify-tui/config.yml（不要与处理 Spotify 身份验证的 client.yml 混淆）

以下是一个示例 config.yml 文件

# Sample config file

# The theme colours can be an rgb string of the form "255, 255, 255" or a string that references the colours from your terminal theme: Reset, Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White.
theme:
  active: Cyan # current playing song in list
  banner: LightCyan # the "spotify-tui" banner on launch
  error_border: Red # error dialog border
  error_text: LightRed # error message text (e.g. "Spotify API reported error 404")
  hint: Yellow # hint text in errors
  hovered: Magenta # hovered pane border
  inactive: Gray # borders of inactive panes
  playbar_background: Black # background of progress bar
  playbar_progress: LightCyan # filled-in part of the progress bar
  playbar_progress_text: Cyan # song length and time played/left indicator in the progress bar
  playbar_text: White # artist name in player pane
  selected: LightCyan # a) selected pane border, b) hovered item in list, & c) track title in player
  text: "255, 255, 255" # text in panes
  header: White # header text in panes (e.g. 'Title', 'Artist', etc.)

behavior:
  seek_milliseconds: 5000
  volume_increment: 10
  # The lower the number the higher the "frames per second". You can decrease this number so that the audio visualisation is smoother but this can be expensive!
  tick_rate_milliseconds: 250
  # Enable text emphasis (typically italic/bold text styling). Disabling this might be important if the terminal config is otherwise restricted and rendering text escapes interferes with the UI.
  enable_text_emphasis: true
  # Controls whether to show a loading indicator in the top right of the UI whenever communicating with Spotify API
  show_loading_indicator: true
  # Disables the responsive layout that makes the search bar smaller on bigger
  # screens and enforces a wide search bar
  enforce_wide_search_bar: false
  # Determines the text icon to display next to "liked" Spotify items, such as
  # liked songs and albums, or followed artists. Can be any length string.
  # These icons require a patched nerd font.
  liked_icon: ♥
  shuffle_icon: 🔀
  repeat_track_icon: 🔂
  repeat_context_icon: 🔁
  playing_icon: ▶
  paused_icon: ⏸

keybindings:
  # Key stroke can be used if it only uses two keys:
  # ctrl-q works,
  # ctrl-alt-q doesn't.
  back: "ctrl-q"

  jump_to_album: "a"

  # Shift modifiers use a capital letter (also applies with other modifier keys
  # like ctrl-A)
  jump_to_artist_album: "A"

  manage_devices: "d"
  decrease_volume: "-"
  increase_volume: "+"
  toggle_playback: " "
  seek_backwards: "<"
  seek_forwards: ">"
  next_track: "n"
  previous_track: "p"
  copy_song_url: "c"
  copy_album_url: "C"
  help: "?"
  shuffle: "ctrl-s"
  repeat: "r"
  search: "/"
  audio_analysis: "v"
  jump_to_context: "o"
  basic_view: "B"
  add_item_to_queue: "z"

限制

此应用使用 Spotify 的 Web API，它本身不处理流媒体。因此，您需要打开官方 Spotify 客户端或使用更轻量级的替代品，例如 spotifyd。

如果您想播放曲目，Spotify 要求您拥有 Premium 账户。

与 spotifyd 一起使用

按照 spotifyd 文档进行设置。

之后就没有太多的事情了。

1. 启动 spotifyd 守护进程。
2. 启动 spt
3. 按 d 进入设备选择菜单，spotifyd "设备" 应该在那里 - 如果不在，请检查 这些文档

使用的库

• tui-rs
• rspotify

开发

1. 安装 OpenSSL
2. 安装 Rust
3. 安装 xorg-dev（用于剪贴板支持）
4. 克隆或分叉此存储库并将其 cd 到其中
5. 然后执行 cargo run

Windows Linux 子系统

您可能会遇到链接错误。如果是这样，您可能需要安装剪贴板包所需的一些附加依赖项

sudo apt-get install -y -qq pkg-config libssl-dev libxcb1-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev

贡献者

感谢这些可爱的人（emoji key）

Alexander Keliris 💻 📖 🎨 📝 🤔 🚇 🚧 📦 👀	Mickael Marques 💵	Grzegorz Koperwas 📖	Austin Gassert 💻	Calen Robinette 💻	M*C*O 🚇	Andrew Chin 💻
Sam Naser 💻	Micha 💻	neriglissar 💻	Timon 💻	echoSayonara 💻	D-Nice 📖 🚇	Grzegorz Pawlik 💻
Lennart Bernhardt 💻	Arnaud Lefebvre 💻	tem1029 💻	Peter K. Moss 💻	Geoff Shannon 💻	Zachary Mayhew 💻	jfaltis 💻
Marcel Schramm 📖	Fangyi Zhou 💻	Max 💻	Sven van der Vlist 💻	jacobchrismarsh 💻	Nils Rauch 💻	Nick Stockton 💻 🐛 🚧 💬 📖
Stuart Hinson 💻	Sam Calvert 💻 📖	Jeroen Wijenbergh 📖	Kimberley Cook 📖	Audrey Baxter 💻	Norman 📖	Peter Maatman 💻
AlexandreS 💻	Finn Vos 💻	Carlos Hernandez 📦	Pedro Alves 💻	jtagcat 📖	Benjamin Kitor 💻	Aleš Najmann 📖 📦
Jeremy Stucki 💻	(´⌣`ʃƪ) 💻	Artem Polishchuk 📦	Chris Sosnin 💻	Ben Buhse 📖	Sean Li 💻	TimotheeGerber 💻 📖
Ferdinand Ratajczak 💻	Sheel Choksi 💻	Michael Hellwig 📖	Oliver Daniel 💻	Drew Fisher 💻	ncoder-1 📖	Macguire Rintoul 📖
Ricardo Holguin 💻	Keisuke Toyota 💻	Craig Astill 💻	Onielfa 💻	usrme 📖	Sergey A. 💻	Hideyuki Okada 💻
kepae 💻 📖	Érico Nogueira Rolim 💻	Alexander Meinhardt Scheurer 💻	Ondřej Kinšt 💻	Kryan90 📖	n-ivanov 💻	bi1yeu 💻 📖
May 💻	Bruno A. Muciño 💻	Finn Hediger 💻	dp304 💻	Marco Micera 📖	Marco Ieni 🚇	Artúr Kovács 💻
Antony Kellermann 💻	Rasmus Pedersen 💻	noir-Z 📖	David Bailey 📖	sheepwall 💻	Hwatwasthat 💻	Jesse 💻
Sang 📖	Yuuki Takahashi 📖	Alejandro Angulo 💻	Anton Kostin 📖	Justin Sexton 💻	Jiati Le 📖	Matthew Cobbing 💻

本项目遵循all-contributors规范。欢迎任何形式的贡献！

路线图

目标是最终实现几乎所有的Spotify功能。

尚未实施的高级要求

• 向播放列表添加歌曲
• 能够在每个视图中滚动结果页面

此表显示了Spotify API所能实现的所有功能，哪些已经实现，以及哪些是必需的。