Skip to content

improve help output #1642

@hohwille

Description

@hohwille

Feature idea

IMHO the current CLI is not yet intuitive.
ide --help shows:

Usage: ide [option]* [[commandlet] [arg]*]

Further ide update --help shows:

Usage: ide [option]* update
Pull your settings and apply updates (software, configuration and repositories).
To update your IDE (if instructed by your ide-admin), you only need to run the following command: 'ide update'.

Values:

Options:
--force-plugins       force plugin (re)installation.
--force-pull          force pull of settings even for code repository.
--force-repositories  force setup of repositories to even clone inactive and pull existing ones.
--locale              the locale (e.g. '--locale=de' for German language).
--no-colors           disable colored log messages.
--skip-repositories   skip the setup of repositories.
--skip-tools          skip the installation/update of tools.
--skip-updates        disables tool updates if the configured versions match the installed versions.
-b | --batch          enable batch mode (non-interactive).
-d | --debug          enable debug logging.
-f | --force          enable force mode.
-o | --offline        enable offline mode (skip updates or git pull, fail downloads or git clone).
-p | --privacy        enable GDPR-compliant console output.
-q | --quiet          disable info logging (only log success, warning or error).
-t | --trace          enable trace logging.

We should replace [option]* with [global-option]* and get something like this for ide update --help:

Usage: ide [global-option]* update [commandlet-option]*
Pull your settings and apply updates (software, configuration and repositories).
To update your IDE (if instructed by your ide-admin), you only need to run the following command: 'ide update'.

Global-Options:
--locale              the locale (e.g. '--locale=de' for German language).
--no-colors           disable colored log messages.
--skip-updates        disables tool updates if the configured versions match the installed versions.
-b | --batch          enable batch mode (non-interactive).
-d | --debug          enable debug logging.
-f | --force          enable force mode.
-o | --offline        enable offline mode (skip updates or git pull, fail downloads or git clone).
-p | --privacy        enable GDPR-compliant console output.
-q | --quiet          disable info logging (only log success, warning or error).
-t | --trace          enable trace logging.

Commandlet-Options:
--force-plugins       force plugin (re)installation.
--force-pull          force pull of settings even for code repository.
--force-repositories  force setup of repositories to even clone inactive and pull existing ones.
--skip-repositories   skip the setup of repositories.
--skip-tools          skip the installation/update of tools.

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    CLIIDEasy command-line-interface (parsing args, etc.)enhancementNew feature or requesthelphelp/usage output

    Projects

    Status

    🆕 New

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions