Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aeyoll/soulseek-cli
A Soulseek Cli client.
https://github.com/aeyoll/soulseek-cli
cli node nodejs soulseek
Last synced: about 1 month ago
JSON representation
A Soulseek Cli client.
- Host: GitHub
- URL: https://github.com/aeyoll/soulseek-cli
- Owner: aeyoll
- License: mit
- Created: 2017-10-01T19:24:06.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-04T19:17:47.000Z (9 months ago)
- Last Synced: 2024-11-09T17:51:44.955Z (about 1 month ago)
- Topics: cli, node, nodejs, soulseek
- Language: JavaScript
- Homepage:
- Size: 384 KB
- Stars: 124
- Watchers: 7
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Soulseek CLI
[](https://travis-ci.org/aeyoll/soulseek-cli)
A Soulseek Cli client.
Requirements
---
NodeJS >= 20
Installation
---
```sh
npm install -g soulseek-cli
```
### On Linux
One of soulseek-cli dependencies ([node-keytar](https://github.com/atom/node-keytar)) uses libsecret, so you need to install it before running `npm install`.
Depending on your distribution, you will need to run the following command:
- Debian/Ubuntu: `sudo apt-get install libsecret-1-dev`
- Red Hat-based: `sudo yum install libsecret-devel`
- Arch Linux: `sudo pacman -S libsecret`
### On Headless Linux
On Linux, [node-keytar](https://github.com/atom/node-keytar) uses the Linux SecretService API. It is possible to use the SecretService backend on Linux systems without X11 server available (only D-Bus is required). In this case, you can do the following (exemple is on a Debian environment):
#### Install dependencies
```sh
apt install gnome-keyring --no-install-recommends # Install the GNOME Keyring daemon. "no-install-recommends" prevents X11 install
```
#### Usage
```sh
dbus-run-session -- $SHELL # Start a D-Bus session
echo 'root' | /usr/bin/gnome-keyring-daemon -r -d --unlock # Unlock GNOME Keyring
soulseek ... # Use soulseek-cli normally
```
Commands
---
### Login
Before being able to search, you need to be logged in.
Usage:
```
soulseek login
```
You will be prompted your Soulseek login and password. Credentials are stored and encrypted in your system keychain.
Alternatively, you can also login by setting environment variables:
```sh
export SOULSEEK_ACCOUNT=youraccount
export SOULSEEK_PASSWORD=yourpassword
soulseek download "..."
```
### Download
Download with required query.
Usage:
```
soulseek download|d [options] [query...]
```
:warning: This command used to be called `search` in versions prior to 0.1.0.
Options:
| Option | Description |
| ------------------------- | ----------------------------------------------------------------------------- |
| -d --destination | downloads's destination |
| -q --quality | show only mp3 with a defined quality |
| -m --mode | filter the kind of files you want (available: "mp3", "flac", default: "mp3") |
| -h --help | display help for command |
Examples:
```sh
soulseek download "Your query" # Download in the current folder
soulseek download "Your query" --destination=/path/to/directory # Download in a defined folder (relative or absolute)
soulseek download "Your query" --quality=320 # Filter by quality
soulseek download "Your query" --mode=flac # Filter by file type
```
### Query
Search with required query, but don't download anything. If a result is found, the return code will be 0. Otherwise,
the return code will be 1 (useful for scripting)
Usage:
```
soulseek query|q [options] [query...]
```
Options:
| Option | Description |
| ---------------------- | ---------------------------------------------------------------------------- |
| -q --quality | show only mp3 with a defined quality |
| -m --mode | filter the kind of files you want (available: "mp3", "flac", default: "mp3") |
| -h --help | display help for command |
Contribution
---
See [CONTRIBUTING.md](CONTRIBUTING.md).