Metadata-Version: 2.4
Name: EchoVault-CLI
Version: 0.0.4
Summary: EchoVault-CLI connector for EchoVault
Project-URL: Documentation, https://github.com/ACS-lessgo/EchoVault-CLI#readme
Project-URL: Issues, https://github.com/ACS-lessgo/EchoVault-CLI/issues
Project-URL: Source, https://github.com/ACS-lessgo/EchoVault-CLI
Author-email: ACS-lessgo <royalcs379@gmail.com>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Requires-Dist: pygame>=2.5.2
Requires-Dist: textual>=0.50.0
Description-Content-Type: text/markdown

# EchoVault CLI

A terminal (TUI) music player for your [EchoVault](https://github.com/ACS-lessgo/EchoVault) library, built with [Textual](https://github.com/Textualize/textual) and `pygame`.

-----

## Requirements

EchoVault CLI doesn't manage its own music library — it reads the same local database that the main [EchoVault](https://github.com/ACS-lessgo/EchoVault) desktop app builds when you add folders to your library. Install and run EchoVault at least once first, so `~/.config/EchoVault/sonicbox.db` exists and has tracks in it.

## Installation

```console
pip install EchoVault-CLI
```

Requires Python >= 3.8.

## Usage

Run the player from a terminal:

```console
echovault
```

Select a track in the list and use these keys to control playback:

| Key     | Action              |
|---------|----------------------|
| `space` | Play / Pause         |
| `n`     | Next track           |
| `p`     | Previous track       |
| `s`     | Toggle shuffle       |
| `r`     | Toggle repeat        |
| `+`     | Volume up            |
| `-`     | Volume down          |
| `q`     | Quit                 |

## CLI Preview

- ![EchoVault CLI theme 1](Screenshots/cli1.png)

- ![EchoVault CLI theme 2](Screenshots/cli2.png)

## Related Projects

- [EchoVault](https://github.com/ACS-lessgo/EchoVault) — the main desktop music player this CLI complements.

## License

`EchoVault-CLI` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
