Skip to content

Document CLI API #553

Open
Open
@j0sh

Description

@j0sh

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions