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

Document CLI API #553

Open
j0sh opened this issue Sep 5, 2018 · 3 comments
Open

Document CLI API #553

j0sh opened this issue Sep 5, 2018 · 3 comments

Comments

@j0sh
Copy link
Collaborator

j0sh commented Sep 5, 2018

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.

@blake41
Copy link

blake41 commented Sep 7, 2018

Ahh this is awesome, thanks @j0sh

@ericxtang
Copy link
Member

We should examine each API endpoint to make sure they are ready to be used by an external user, and after that document them.

@status-open-bounty
Copy link

status-open-bounty commented Jan 24, 2019

Current balance: 0.0 ETH
Contract address: 0x5190c82e018fff6457bb058b6bdb51aa67cdd2f3
QR Code
Network: Mainnet
To claim this bounty sign up at https://openbounty.status.im and make sure to update your Ethereum address in My Payment Details so that the bounty is correctly allocated.
To fund it, send ETH or ERC20/ERC223 tokens to the contract address.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants