search

livepeer / go-livepeer

Official Go implementation of the Livepeer protocol
http://livepeer.org
MIT License
538 stars 169 forks source link

Document CLI API #553

Open j0sh opened 6 years ago

j0sh commented 6 years ago

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 commented 6 years ago

Ahh this is awesome, thanks @j0sh

ericxtang commented 5 years ago

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 commented 5 years ago

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.