Feature #28441: Add information about required options in help output - Hammer CLI - Foreman

Actions

Copy link

Feature #28441

closed

Tracker #27706: Make the options more readable in the command help

Add information about required options in help output

Added by Oleh Fedorenko over 5 years ago. Updated almost 5 years ago.

Status:

Duplicate

Priority:

Normal

Assignee:

Oleh Fedorenko

Category:

User experience

Target version:

Difficulty:

Triaged:

Yes

Bugzilla link:

Pull request:

Team Backlog:

Fixed in Releases:

Found in Releases:

hammer-cli-0.15.1

In Kanboard:

Red Hat JIRA:

Description

There's no way to mark options for identifiers of resources that are required, because they can exist in multiple
complementary variants.

In combinations like (`--organization`, `--organization-id`, `--organization-label`) or (`--name` and `--id`)
there is only one of the options required, therefore we can't simply put "(required)" into the option descriptions
for each of them (the standard way in Clamp).

Another issue is dependencies between options.
Most of resources in Katello are scoped to some other resource (to organization at minimum) and their name and/or label identifiers are
unique only in this scope. When this is translated to command options necessary for resolving names to ids it creates dependencies.