Proposal: Improve eKuiper command-line tools maintainability and usability

[yai-dev]

What would you like to be added/modified:

1. We need seperating kuiper's sub-commands into different .go files, each sub-commands has it own .go file.

2. Command-Line tools arguments naming should be kebab-case.

3. KuiperBaseKey environment should be public to users and documented and it's naming should be upper case and seperate with underscore.

4. Add version flag to get version of kuiper and kuiperd.

Why is this needed:

Currently, eKuiper's command-line tools, which include kuiperd and kuiper, offer a lots of functions that made developers and users could work on terminal. However, the arguments are not always clear, and the sub-commands of kuiper are written in a single .go file, which complicates maintenance.

Above are all the optimizations I can think of. If you have better suggestions, please reply in the issue to join the discussion.

BTW: This proposal is outside the roadmap maybe? and I can try to work on it.

[yai-dev]

I think eKuiper could provide SQL like prompt experience includes create rule, table and stream for users but not just query, and this feature has lot's of work to do and priority should lower than primary topic for this issue.

[ngjaying]

Thanks for the proposal. I am OK with the refactor. But renaming the commands sound like breaking changes. Recommend to do that in the master-v2 branch.

[yai-dev]

Thanks for the proposal. I am OK with the refactor. But renaming the commands sound like breaking changes. Recommend to do that in the master-v2 branch.

You may have misunderstood. I'm not proposing to rename the commands, but rather to group them into separate .go files, which would make maintenance easier.

And extends the query command's prompt, adding the new feature such like create rule, create table and create stream.

Below is examples:

$ kuiper query

kuiper > CREATE STREAM stream_name ( column_name <data_type> [ ,...n ] ) WITH ( property_name = expression [, ...] );
kuiper > CREATE TABLE table_name ( column_name <data_type> [ ,...n ] ) WITH ( property_name = expression [, ...] );
kuiper > DESCRIBE TABLE table_name;

And this feature is not higher priority and not must have cuz there already has same commands could work (kuiper create)

[yai-dev]

This proposal must guarantee eKuiper's users has same experience after refactored, that is 1st accept criteria.

[yai-dev]

@ngjaying perhaps we need to vote on this proposal? What steps should I take to start working on this?

[ngjaying]

Hi @yai-dev , if no breaking change, you can start to work on this if you like. Thanks

[yai-dev]

Hi @yai-dev , if no breaking change, you can start to work on this if you like. Thanks

OK, please assign this issue to me and i'm ready to working on it, and refactor will based on branch master-v2.

[ngjaying]

Thanks. Notice that, CLI is temporarily removed in v2 now. You can try to added it back progressively.

[yai-dev]

Thanks. Notice that, CLI is temporarily removed in v2 now. You can try to added it back progressively.

OKay