[
https://issues.apache.org/jira/browse/IGNITE-22777?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Iurii Gerzhedovich updated IGNITE-22777:
----------------------------------------
Description:
I've tried to use CLI in AI3, it's cool and a big improvement in usability
compared to AI2.
However, there are many places to make it more user-friendly and look better.
What I suggest:
# As a user, I should know that cluster need to be initialized. The first
action in CLI is to connect to a node. We know that cluster not inited, let's
show the suggestion to the user that it is required and show suggestions on
what needs to do. And do it for any command required initialized cluster,
instead of show strange errors like {{196609 Trace ID:
c5bc2dc3-7ed8-4191-b65a-559db9e680b1}}
# When I see the usage of cluster init I see 2 mandatory parameters, but it is
hard to look, at due to them mixed with optional parameters - let's move all
mandatory parameters to the beginning. It related to any CLI commands, not only
to `cluster init`
# For all commands let's add the following options: #
## {{`requiredOptionMarker = '*'`}} to mark mandatory options in usage section
## `{{{}usageHelpAutoWidth = true{}}} `to use width of user terminal
## `descriptionHeading = "%n"` to split the first and the second parts
was:
I've tried to use CLI in AI3, it's cool and a big improvement in usability
compared to AI2.
However, there are many places to make it more user-friendly and look better.
What I suggest: # As a user, I should know that cluster need to be initialized.
The first action in CLI is to connect to a node. We know that cluster not
inited, let's show the suggestion to the user that it is required and show
suggestions on what needs to do. And do it for any command required initialized
cluster, instead of show strange errors like {{196609 Trace ID:
c5bc2dc3-7ed8-4191-b65a-559db9e680b1}}
# When I see the usage of cluster init I see 2 mandatory parameters, but it is
hard to look, at due to them mixed with optional parameters - let's move all
mandatory parameters to the beginning. It related to any CLI commands, not only
to `cluster init`
# For all commands let's add the following options: #
## {{`requiredOptionMarker = '*'`}} to mark mandatory options in usage section
## `{{{}usageHelpAutoWidth = true{}}} `to use width of user terminal
## `descriptionHeading = "%n"` to split the first and the second parts
> Improve CLI usability
> ---------------------
>
> Key: IGNITE-22777
> URL: https://issues.apache.org/jira/browse/IGNITE-22777
> Project: Ignite
> Issue Type: Improvement
> Reporter: Iurii Gerzhedovich
> Priority: Major
> Labels: ignite-3
>
> I've tried to use CLI in AI3, it's cool and a big improvement in usability
> compared to AI2.
> However, there are many places to make it more user-friendly and look better.
> What I suggest:
> # As a user, I should know that cluster need to be initialized. The first
> action in CLI is to connect to a node. We know that cluster not inited, let's
> show the suggestion to the user that it is required and show suggestions on
> what needs to do. And do it for any command required initialized cluster,
> instead of show strange errors like {{196609 Trace ID:
> c5bc2dc3-7ed8-4191-b65a-559db9e680b1}}
> # When I see the usage of cluster init I see 2 mandatory parameters, but it
> is hard to look, at due to them mixed with optional parameters - let's move
> all mandatory parameters to the beginning. It related to any CLI commands,
> not only to `cluster init`
> # For all commands let's add the following options: #
> ## {{`requiredOptionMarker = '*'`}} to mark mandatory options in usage
> section
> ## `{{{}usageHelpAutoWidth = true{}}} `to use width of user terminal
> ## `descriptionHeading = "%n"` to split the first and the second parts
>
>
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
