[GH-ISSUE #647] Better documentation of the CLI #1314

New issue

Open

opened 2026-03-14 14:21:51 +03:00 by kerem · 1 comment

kerem commented

2026-03-14 14:21:51 +03:00

Owner

Originally created by @coreymwamba on GitHub (Dec 29, 2024).
Original GitHub issue: https://github.com/aome510/spotify-player/issues/647

Is your feature already implemented in the latest master?
No.

Is your feature request related to a problem? Please describe.
In many ways, spotify-player is the closest I have come to having a seamless headless setup. However, the help/documentation is not as helpful as it could be. I've currently spent many hours of trial and error working out exactly how to get the various search functions to work. The documentation doesn't mention that results will come as JSON responses and that the user will need to do some work to use the response. I understand that the focus is more as a TUI, but right now I'm running it as a daemon and it's better than a lot of other solutions. I think it just needs a few helpers.

Describe the solution you'd like
I am willing to help write documentation and use cases for any of the CLI commands. I'm in the process of writing a Bash wrapper to help with finding albums, artists, and tracks; and will add them to my repo once I've tested them (next few days). Obviously people can critique/adapt/expand as they wish! But I think it could really help with the adoption of the application.

I think more could be added to the CLI, such as being able to find and play a single track (there is no way of doing this through the CLI).

Describe alternatives you've considered
I have already tried spotifyd. Its documentation is even worse, to the point of being wilfully unhelpful. And there's no need for that.

Originally created by @coreymwamba on GitHub (Dec 29, 2024). Original GitHub issue: https://github.com/aome510/spotify-player/issues/647 **Is your feature already implemented in the latest `master`?** No. **Is your feature request related to a problem? Please describe.** In many ways, spotify-player is the closest I have come to having a seamless headless setup. However, the help/documentation is not as helpful as it could be. I've currently spent many hours of trial and error working out exactly how to get the various search functions to work. The documentation doesn't mention that results will come as JSON responses and that the user will need to do some work to use the response. I understand that the focus is more as a TUI, but right now I'm running it as a daemon and it's better than a lot of other solutions. I think it just needs a few helpers. **Describe the solution you'd like** I am willing to help write documentation and use cases for any of the CLI commands. I'm in the process of writing a Bash wrapper to help with finding albums, artists, and tracks; and will add them to my repo once I've tested them (next few days). Obviously people can critique/adapt/expand as they wish! But I think it could really help with the adoption of the application. I think more could be added to the CLI, such as being able to find and play a single track (there is no way of doing this through the CLI). **Describe alternatives you've considered** I have already tried spotifyd. Its documentation is even worse, to the point of being wilfully unhelpful. And there's no need for that.

kerem added the

enhancement

label

2026-03-14 14:21:51 +03:00

kerem commented

2026-03-14 14:22:02 +03:00

Author

Owner

@trames57 commented on GitHub (Feb 20, 2025):

I have seen other github projects that have a Wiki tab along the top. If the instructions were put there, users can edit and modify the wiki to add helpful hints and examples. I have done this with other projects after I spent hours researching something so others may not need to.

I have also seen a Discussions tab that can be searched for helpful hints.

@trames57 commented on GitHub (Feb 20, 2025): I have seen other github projects that have a Wiki tab along the top. If the instructions were put there, users can edit and modify the wiki to add helpful hints and examples. I have done this with other projects after I spent hours researching something so others may not need to. I have also seen a Discussions tab that can be searched for helpful hints.