{"id":16149925,"url":"https://github.com/aeyoll/soulseek-cli","last_synced_at":"2025-04-04T10:10:02.220Z","repository":{"id":27729902,"uuid":"105467950","full_name":"aeyoll/soulseek-cli","owner":"aeyoll","description":"A Soulseek Cli client.","archived":false,"fork":false,"pushed_at":"2024-12-21T10:54:29.000Z","size":449,"stargazers_count":136,"open_issues_count":0,"forks_count":8,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-28T09:06:45.728Z","etag":null,"topics":["cli","node","nodejs","soulseek"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aeyoll.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-10-01T19:24:06.000Z","updated_at":"2025-03-09T10:12:09.000Z","dependencies_parsed_at":"2024-12-21T11:27:10.752Z","dependency_job_id":"3a6e367d-de19-4260-91f1-218be1935461","html_url":"https://github.com/aeyoll/soulseek-cli","commit_stats":{"total_commits":160,"total_committers":4,"mean_commits":40.0,"dds":"0.22499999999999998","last_synced_commit":"03495dcb643b5f28236895d2469daa86973e9f18"},"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeyoll%2Fsoulseek-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeyoll%2Fsoulseek-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeyoll%2Fsoulseek-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeyoll%2Fsoulseek-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aeyoll","download_url":"https://codeload.github.com/aeyoll/soulseek-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247157242,"owners_count":20893216,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","node","nodejs","soulseek"],"created_at":"2024-10-10T00:45:55.400Z","updated_at":"2025-04-04T10:10:02.196Z","avatar_url":"https://github.com/aeyoll.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Soulseek CLI\n\n[![Build Status](https://travis-ci.org/aeyoll/soulseek-cli.svg?branch=develop)](https://travis-ci.org/aeyoll/soulseek-cli)\n\nA Soulseek Cli client.\n\nRequirements\n---\n\nNodeJS \u003e= 20\n\nInstallation\n---\n\n```sh\nnpm install -g soulseek-cli\n```\n\n### On Linux\n\nOne of soulseek-cli dependencies ([node-keytar](https://github.com/atom/node-keytar)) uses libsecret, so you need to install it before running `npm install`.\n\nDepending on your distribution, you will need to run the following command:\n\n- Debian/Ubuntu: `sudo apt-get install libsecret-1-dev`\n- Red Hat-based: `sudo yum install libsecret-devel`\n- Arch Linux: `sudo pacman -S libsecret`\n\n### On Headless Linux\n\nOn 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):\n\n#### Install dependencies\n\n```sh\napt install gnome-keyring --no-install-recommends # Install the GNOME Keyring daemon. \"no-install-recommends\" prevents X11 install\n```\n\n#### Usage\n\n```sh\ndbus-run-session -- $SHELL # Start a D-Bus session\necho 'root' | /usr/bin/gnome-keyring-daemon -r -d --unlock # Unlock GNOME Keyring\nsoulseek ... # Use soulseek-cli normally\n```\n\nCommands\n---\n\n### Login\n\nBefore being able to search, you need to be logged in.\n\nUsage:\n```\nsoulseek login\n```\n\nYou will be prompted your Soulseek login and password. Credentials are stored and encrypted in your system keychain.\n\nAlternatively, you can also login by setting environment variables:\n\n```sh\nexport SOULSEEK_ACCOUNT=youraccount\nexport SOULSEEK_PASSWORD=yourpassword\nsoulseek download \"...\"\n```\n\n### Download\n\nDownload with required query.\n\nUsage:\n```\nsoulseek download|d [options] [query...]\n```\n\n:warning: This command used to be called `search` in versions prior to 0.1.0.\n\nOptions:\n\n| Option                    | Description                                                                   |\n| ------------------------- | ----------------------------------------------------------------------------- |\n| -d --destination \u003cfolder\u003e | downloads's destination                                                       |\n| -q --quality \u003cquality\u003e    | show only mp3 with a defined quality                                          |\n| -m --mode \u003cmode\u003e          | filter the kind of files you want (available: \"mp3\", \"flac\", default: \"mp3\")  |\n| -h --help                 | display help for command                                                      |\n\nExamples:\n\n```sh\nsoulseek download \"Your query\" # Download in the current folder\nsoulseek download \"Your query\" --destination=/path/to/directory # Download in a defined folder (relative or absolute)\nsoulseek download \"Your query\" --quality=320 # Filter by quality\nsoulseek download \"Your query\" --mode=flac # Filter by file type\n```\n\n### Query\n\nSearch with required query, but don't download anything. If a result is found, the return code will be 0. Otherwise,\nthe return code will be 1 (useful for scripting)\n\nUsage:\n\n```\nsoulseek query|q [options] [query...]\n```\n\nOptions:\n\n| Option                 | Description                                                                  |\n| ---------------------- | ---------------------------------------------------------------------------- |\n| -q --quality \u003cquality\u003e | show only mp3 with a defined quality                                         |\n| -m --mode \u003cmode\u003e       | filter the kind of files you want (available: \"mp3\", \"flac\", default: \"mp3\") |\n| -h --help              | display help for command                                                     |\n\n\n\nContribution\n---\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faeyoll%2Fsoulseek-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faeyoll%2Fsoulseek-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faeyoll%2Fsoulseek-cli/lists"}