[IGNITE-22108] Rename options in CLI

• Type: Task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.0
• Component/s: cli
• Labels: ignite-3
• Ignite Flags: Docs Required, Release Notes Required
• Assignee: Aleksandr
• Reporter: Aleksandr
• Created: 25/Apr/24 08:42
• Updated: 04/Sep/24 16:08
• Resolved: 22/May/24 09:11

Description

The original CLI IEP offers both long and short options for some commands, for example
--cluster-endpoint-url localhost:8080 and
-u localhost:8080

The CLI is becoming more complex than it was before. We add new commands and new options constantly. Now we can observe some confusions in short options across some commands.

The proposal for CLI short options is to define the following conventions:

• Use exactly one letter for the short options.
• Do not overwrite the one if it is already defined for some command.
• Use short options only for commands that will probably be used frequently.

Proposed short options:
-n for node-name
-h for help
-v for verbose
-u for user
-p for password

All other short options should be dropped.

Also some common options might be shorten:

• cluster-endpoint-url, node-url → url
• cluster-config → config
• cluster-config-file → config-file
• script-file → file
• cluster-name, node-name → name
• meta-storage-node → ms-node

Issue Links

• links to: GitHub Pull Request #3750