A Soulseek Cli client.
NodeJS >= 20
npm install -g soulseek-cliOne of soulseek-cli dependencies (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 Linux, 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):
apt install gnome-keyring --no-install-recommends # Install the GNOME Keyring daemon. "no-install-recommends" prevents X11 installdbus-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 normallyBefore 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:
export SOULSEEK_ACCOUNT=youraccount
export SOULSEEK_PASSWORD=yourpassword
soulseek download "..."Download with required query.
Usage:
soulseek download|d [options] [query...]
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:
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 typeSearch 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 |
See CONTRIBUTING.md.