From d8ed475efc24abf0314bd0d57b015c21a5b25e8b Mon Sep 17 00:00:00 2001 From: Chaitanya Sharma Date: Wed, 19 Aug 2026 13:50:48 +0530 Subject: [PATCH] docs(app-automation): fix broken HyperExecute CLI flags and SmartUI nav labels Three fixes, all verified against the real CLI and the installed Docusaurus. 1. HyperExecute CLI credentials flags. The XCUI sharding page documented `--u` / `--k`. The CLI is cobra/pflag based and exposes `-u, --user` and `-k, --key`, so `--u` is rejected outright: $ ./hyperexecute --u my_user_name --k xyz123abc ... Error: unknown flag: --u The Espresso sharding page documented `-user` / `-key`, which is worse because it does not error. pflag reads `-user` as shorthand `-u` with the value `ser`, then treats the real username as a command: $ ./hyperexecute -user my_user_name -key xyz123abc ... Error: unknown command "my_user_name" for "HyperExecute" Both now use `-u` / `-k`, which parse correctly (verified: they reach authentication instead of failing at flag parsing). A scan of docs/ and static/docs/ confirms these were the only two pages out of step; the remaining 314 invocations already use `--user` / `--key`. The `-apiKey` in the Katalon page belongs to `katalonc`, not HyperExecute, and is left alone. 2. SmartUI visual regression sidebar label. The XCUI visual regression page appeared in the sidebar as just "XCUI". sidebars.js already set `label: "SmartUI Visual Regression"`, but that had no effect: Docusaurus resolves a doc item's label as label: sidebarLabel ?? item.label ?? title (plugin-content-docs/lib/props.js), so the frontmatter `sidebar_label` won. Removing the frontmatter override lets each sidebar supply its own context-appropriate label: "SmartUI Visual Regression" under XCUI Testing, and "XCUITest" under SmartUI > Native Apps. 3. Espresso visual regression was missing from the Espresso nav. The page exists and is complete, but was only reachable from SmartUI > Native Apps, while the XCUI equivalent was also linked from XCUI Testing. Added the matching entry so both frameworks are discoverable the same way. Co-Authored-By: Claude Opus 5 (1M context) Claude-Session: https://claude.ai/code/session_01DdZjipHk3bGHmZBvwoTXvi --- docs/espresso-visual-regression.md | 1 - docs/sharding-espresso.md | 4 ++-- docs/sharding-xcui.md | 4 ++-- docs/xcui-visual-regression.md | 1 - sidebars.js | 5 +++++ static/docs/sharding-espresso-rd-hyperexecute.md | 4 ++-- static/docs/sharding-rd-hyperexec.md | 4 ++-- 7 files changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/espresso-visual-regression.md b/docs/espresso-visual-regression.md index df6b4ecf1..06afa1ee8 100644 --- a/docs/espresso-visual-regression.md +++ b/docs/espresso-visual-regression.md @@ -1,7 +1,6 @@ --- id: espresso-visual-regression title: Getting Started With Visual Regression Testing Using Espresso On SmartUI Real Devices -sidebar_label: Espresso description: Dive into our detailed Appium Visual Regression support documentation for step-by-step guidance! Efficiently perform visual testing, manage applications, and ensure your mobile apps are visually perfect before launch. keywords: - Visual Regression diff --git a/docs/sharding-espresso.md b/docs/sharding-espresso.md index db493e5f2..a5d20facc 100644 --- a/docs/sharding-espresso.md +++ b/docs/sharding-espresso.md @@ -445,12 +445,12 @@ If you are using the `deviceSelectionStrategy: any`, then in that case all the s ```bash chmod u+x -./ -user -key --verbose -i .yaml +./ -u -k --verbose -i .yaml ``` You can refer to this example and screenshot below: ``` -./hyperexecute -user my_user_name -key xyx123abc --verbose -i hyperexecute.yaml +./hyperexecute -u my_user_name -k xyx123abc --verbose -i hyperexecute.yaml ``` cmd diff --git a/docs/sharding-xcui.md b/docs/sharding-xcui.md index bcef4630d..975f8216a 100644 --- a/docs/sharding-xcui.md +++ b/docs/sharding-xcui.md @@ -335,12 +335,12 @@ If you are using the `deviceSelectionStrategy: any`, then in that case all the m ```bash chmod u+x -./ --u --k --verbose -i .yaml +./ -u -k --verbose -i .yaml ``` You can refer to this example and screenshot below: ``` -./hyperexecute --u my_user_name --k xyx123abc --verbose -i hyperexecute.yaml +./hyperexecute -u my_user_name -k xyx123abc --verbose -i hyperexecute.yaml ``` cmd diff --git a/docs/xcui-visual-regression.md b/docs/xcui-visual-regression.md index fed5af669..ba357b035 100644 --- a/docs/xcui-visual-regression.md +++ b/docs/xcui-visual-regression.md @@ -1,7 +1,6 @@ --- id: xcui-visual-regression title: Getting Started With Visual Regression Testing Using XCUI On SmartUI Real Devices -sidebar_label: XCUI description: Dive into our detailed XCUI Visual Regression support documentation for step-by-step guidance! Efficiently perform visual testing, manage applications, and ensure your mobile apps are visually perfect before launch. keywords: - Visual Regression diff --git a/sidebars.js b/sidebars.js index 407875912..ed7caaba6 100644 --- a/sidebars.js +++ b/sidebars.js @@ -2634,6 +2634,11 @@ module.exports = { label: "MockWebServer & Localhost", id: "espresso-mockwebserver-localhost", }, + { + type: "doc", + label: "SmartUI Visual Regression", + id: "espresso-visual-regression", + }, ], ], diff --git a/static/docs/sharding-espresso-rd-hyperexecute.md b/static/docs/sharding-espresso-rd-hyperexecute.md index 722cd116f..a18e4cae9 100644 --- a/static/docs/sharding-espresso-rd-hyperexecute.md +++ b/static/docs/sharding-espresso-rd-hyperexecute.md @@ -290,12 +290,12 @@ If you are using the `deviceSelectionStrategy: any`, then in that case all the s ```bash chmod u+x -./ -user -key --verbose -i .yaml +./ -u -k --verbose -i .yaml ``` You can refer to this example and screenshot below: ``` -./hyperexecute -user my_user_name -key xyx123abc --verbose -i hyperexecute.yaml +./hyperexecute -u my_user_name -k xyx123abc --verbose -i hyperexecute.yaml ``` 5. After the test is started you can follow the test on the below links. diff --git a/static/docs/sharding-rd-hyperexec.md b/static/docs/sharding-rd-hyperexec.md index ddda578e2..ac89a9c86 100644 --- a/static/docs/sharding-rd-hyperexec.md +++ b/static/docs/sharding-rd-hyperexec.md @@ -204,12 +204,12 @@ If you are using the `deviceSelectionStrategy: any`, then in that case all the m ```bash chmod u+x -./ --u --k --verbose -i .yaml +./ -u -k --verbose -i .yaml ``` You can refer to this example and screenshot below: ``` -./hyperexecute --u my_user_name --k xyx123abc --verbose -i hyperexecute.yaml +./hyperexecute -u my_user_name -k xyx123abc --verbose -i hyperexecute.yaml ``` 5. After the test is started you can follow the test on the below links.