Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation of the CLI #647

Open
coreymwamba opened this issue Dec 29, 2024 · 0 comments
Open

Better documentation of the CLI #647

coreymwamba opened this issue Dec 29, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@coreymwamba
Copy link

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.

@coreymwamba coreymwamba added the enhancement New feature or request label Dec 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant