Skip to content

Conversation

@MonkeyCanCode
Copy link
Contributor

What changes were proposed in this pull request?

Polaris admin tool was default to show a brief msg which then ask user to use argument help to get more info (which is a kinds no-ops and force user to rerun the command with additional arguments in order to learn more) such as following:

$ java -jar runtime/admin/build/quarkus-app/quarkus-run.jar
Polaris administration & maintenance tool.
Use the 'help' command.

With the change from this PR, I am purposing we should default to help along with original tool message line such as following:

$ java -jar runtime/admin/build/quarkus-app/quarkus-run.jar
Polaris administration & maintenance tool.

Usage: polaris-admin-tool.jar [-hV] [COMMAND]
Polaris Admin Tool
  -h, --help      Show this help message and exit.
  -V, --version   Print version information and exit.
Commands:
  help       Display help information about the specified command.
  bootstrap  Bootstraps realms and root principal credentials.
  purge      Purge realms and all associated entities.

Why are the changes needed?

Does this PR introduce any user-facing change?

IMO, this is provide better user experience and it doesn't make much sense to ask user to type same command and an extra help argument to learn more about the tool.

How was this patch tested?

N/A

CHANGELOG.md

N/A

singhpk234
singhpk234 previously approved these changes Nov 3, 2025
Copy link
Contributor

@singhpk234 singhpk234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SGTM ! thanks @MonkeyCanCode

@github-project-automation github-project-automation bot moved this from PRs In Progress to Ready to merge in Basic Kanban Board Nov 3, 2025
Copy link
Contributor

@dimas-b dimas-b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to the general direction of this improvement. Thanks for working on this @MonkeyCanCode ! Also +1 to @snazy 's comments :)

Copy link
Member

@snazy snazy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!
+1

@MonkeyCanCode MonkeyCanCode merged commit 79973ef into apache:main Nov 4, 2025
15 checks passed
@github-project-automation github-project-automation bot moved this from Ready to merge to Done in Basic Kanban Board Nov 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants