-
Notifications
You must be signed in to change notification settings - Fork 171
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
Document CLI API #553
Comments
Ahh this is awesome, thanks @j0sh |
We should examine each API endpoint to make sure they are ready to be used by an external user, and after that document them. |
Current balance: 0.0 ETH |
Is your feature request related to a problem? Please describe.
There is no documentation for the CLI API, which exposes a lot of useful functionality. Currently, most interaction is done via the
livepeer_cli
app, however this isn't the best UX.The information density and user experience would be greatly improved by writing a Web UI on top of the API, which could also pull information from the local DB. There is a lot of potential for useful community-contributed tools on top of the node, such as a statistics dashboard.
Building this is already possible today, but the knowledge is not generally available outside of those working on the Livepeer goclient. The first step towards resolving this would be to document the CLI API.
Describe the solution you'd like
A fully documented API for the CLI.
The text was updated successfully, but these errors were encountered: