[
https://issues.apache.org/jira/browse/IGNITE-24579?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Vadim Pakhnushev updated IGNITE-24579:
--------------------------------------
Description:
Help information displayed by the current CLI is very scarce.
It doesn't give any hints on how to connect to a different node, run a query
from the file, etc.
While interactive mode is helpful, we also need to provide the user a bit more
information on how to execute the queries and other requests non-interactively
and on different nodes.
The help doesn't provide any information on how to execute the query from file.
While error messages show a hint that the file parameter does in fact exist:
{noformat}
Error: Missing required argument (specify one of these): (--file=<file> |
<command>)
{noformat}
Current help output:
{noformat}
USAGE
ignite [OPTIONS] [COMMAND]
DESCRIPTION
Welcome to Ignite Shell alpha.
Run without command to enter interactive mode.
OPTIONS * - required option
-h, --help Show help for the specified command
-v, --verbose Show additional information: logs, REST calls. This flag is
useful for debugging. Specify multiple options to increase verbosity for REST
calls. Single option shows request and response, second option (-vv) shows
headers, third one (-vvv) shows body
--version Print version information
COMMANDS
sql Executes SQL query
help Display help information about the specified command.
cli CLI specific commands
connect Connects to Ignite 3 node
node Node operations
cluster Manages an Ignite cluster
recovery Manages disaster recovery of Ignite cluster
{noformat}
was:
Help information displayed by the current CLI is very scarce.
It doesn't give any hints on how to connect to a different node, run a query
from the file, etc.
While interactive mode is helpful, we also need to provide the user a bit more
information on how to execute the queries and other requests non-interactively
and on different nodes.
While error messages show a hint that the file parameter does in fact exist:
{noformat}
Error: Missing required argument (specify one of these): (--file=<file> |
<command>) {noformat}
Current help output:
{noformat}
USAGE
ignite [OPTIONS] [COMMAND]DESCRIPTION
Welcome to Ignite Shell alpha.
Run without command to enter interactive mode.
OPTIONS * - required option
-h, --help Show help for the specified command
-v, --verbose Show additional information: logs, REST calls. This flag is
useful for debugging. Specify multiple options to increase
verbosity for REST calls. Single option shows request and
response, second option (-vv) shows headers, third one
(-vvv) shows body
--version Print version informationCOMMANDS
sql Executes SQL query
help Display help information about the specified command.
cli CLI specific commands
connect Connects to Ignite 3 node
node Node operations
cluster Manages an Ignite cluster
recovery Manages disaster recovery of Ignite cluster
distribution Manages partition distribution in zones.
user User management commands
role role management commands
token token management commands
dcr Data center replication commands.
ggtest@lxcnode1:~${noformat}
> Ignite CLI help doesn't show how to connect to a node, run query from file,
> etc
> -------------------------------------------------------------------------------
>
> Key: IGNITE-24579
> URL: https://issues.apache.org/jira/browse/IGNITE-24579
> Project: Ignite
> Issue Type: Bug
> Components: cli
> Affects Versions: 3.0
> Reporter: Yury Yudin
> Priority: Major
> Labels: ignite-3, ignite-3-cli-tool
>
> Help information displayed by the current CLI is very scarce.
> It doesn't give any hints on how to connect to a different node, run a query
> from the file, etc.
> While interactive mode is helpful, we also need to provide the user a bit
> more information on how to execute the queries and other requests
> non-interactively and on different nodes.
>
> The help doesn't provide any information on how to execute the query from
> file.
> While error messages show a hint that the file parameter does in fact exist:
> {noformat}
> Error: Missing required argument (specify one of these): (--file=<file> |
> <command>)
> {noformat}
> Current help output:
> {noformat}
> USAGE
> ignite [OPTIONS] [COMMAND]
> DESCRIPTION
> Welcome to Ignite Shell alpha.
> Run without command to enter interactive mode.
> OPTIONS * - required option
> -h, --help Show help for the specified command
> -v, --verbose Show additional information: logs, REST calls. This flag is
> useful for debugging. Specify multiple options to increase verbosity for REST
> calls. Single option shows request and response, second option (-vv) shows
> headers, third one (-vvv) shows body
> --version Print version information
> COMMANDS
> sql Executes SQL query
> help Display help information about the specified command.
> cli CLI specific commands
> connect Connects to Ignite 3 node
> node Node operations
> cluster Manages an Ignite cluster
> recovery Manages disaster recovery of Ignite cluster
> {noformat}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
