fix: provide a better error message when option parsing fails (#27354)

closes: #16260

Signed-off-by: Steve Hawkins <shawkins@redhat.com>

integration/client-cli/admin-cli/src/main/java/org/keycloak/client/admin/cli/aesh/AeshConsoleCallbackImpl.java

@@ -70,8 +70,9 @@ class AeshConsoleCallbackImpl extends AeshConsoleCallback {
             } catch (Exception e) {
                 console.stop();
 
-                if (e instanceof OptionParserException) {
+                if (e instanceof OptionParserException && "Option: - must be followed by a valid operator".equals(e.getMessage())) {
-                    System.err.println("Unknown command: " + aeshLine.getWords().get(0));
+                    System.err.println("Please double check your command options, one or more of them are not specified correctly. "
+                            + "It is possible to have unintentional overlap with other options. e.g. using --clientid will get mistaken for --client, however --cclientid is needed.");
                 } else {
                     System.err.println(e.getMessage());
                 }

testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/cli/admin/KcAdmTest.java

@@ -226,6 +226,15 @@ public class KcAdmTest extends AbstractAdmCliTest {
         Assert.assertEquals("try help", "Try '" + CMD + " help set-password' for more information", exe.stderrLines().get(1));
     }
 
+    @Test
+    public void testBadOverlappingOption() {
+        KcAdmExec exe = KcAdmExec.execute("config credentials --server http://localhost:8080 --realm master --username admin --password admin");
+
+        assertExitCodeAndStreamSizes(exe, 1, 0, 1);
+        Assert.assertEquals("stderr first line", "Please double check your command options, one or more of them are not specified correctly. "
+                + "It is possible to have unintentional overlap with other options. e.g. using --clientid will get mistaken for --client, however --cclientid is needed.", exe.stderrLines().get(0));
+    }
+
     @Test
     public void testCredentialsServerAndRealmWithDefaultConfig() {
         /*