Command line tool - Githubissues

liftbridge-io / liftbridge

Lightweight, fault-tolerant message streams.

https://liftbridge.io

Apache License 2.0

2.57k stars 107 forks source link

Command line tool #249

Closed Jmgr closed 4 years ago

Jmgr commented 4 years ago

Liftbridge offers a comprehensive and easy to use API, but does not bundle any command line tool at the moment. A Liftbridge CLI could be used in various contexts:

performance evaluation: it could be used to benchmark a particular setup of Liftbridge servers, create streams, publish to them using various parameters and measure time, memory, CPU, and other parameters ;
maintenance: some setups could imply a routine removal of streams in response to a particular event ;
statistics gathering: creating a program using the Liftbridge client API may not always convenient, so it could be useful to get some information like the number of active streams from a command line utility (the tool would then output the data using a well-known format).

We have already implemented a simple tool internally in Go and could contribute it as a PR if there is interest for it.

tylertreat commented 4 years ago

Yes, 100% agree and a CLI tool has been on my mind for a long time. If you have a starting point I'm happy to accept a PR. I think it ought to live in a separate repo?

Jmgr commented 4 years ago

Great! We should be able to create a PR soon.

I think it ought to live in a separate repo?

I think that would make sense, yes. Do you want to create this repo first, and then we can submit a pull request on it?

tylertreat commented 4 years ago

I created a new repo here: https://github.com/liftbridge-io/liftbridge-cli

On Mon, Aug 24, 2020, 7:28 AM Jonathan Mercier-Ganady < notifications@github.com> wrote:

Great! We should be able to create a PR soon.

I think it ought to live in a separate repo?

I think that would make sense, yes. Do you want to create this repo first, and then we can submit a pull request on it?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/liftbridge-io/liftbridge/issues/249#issuecomment-679126147, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAEG64MTAKECVLZUSX32E3TSCJTIDANCNFSM4QHO32AQ .

Jmgr commented 4 years ago

Thanks. I have created a draft PR: https://github.com/liftbridge-io/liftbridge-cli/pull/1

There is still some work to do if we want to expose all the API, but this could be a first step. All comments are welcome.