Skip to content

Commit 0747d1e

Browse files
committed
Made textual changes to include release 1.1 changes
1 parent 631862a commit 0747d1e

File tree

1 file changed

+29
-8
lines changed

1 file changed

+29
-8
lines changed

docs/hyperexecute-cli-gui.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ import TabItem from '@theme/TabItem';
4747

4848
:::info Currently in BETA
4949

50-
HyperExecute GUI is currently in **BETA** and supports the **Java TestNG Framework (Java Version 11 & above)**. We're actively working on expanding support to more frameworks. If you have specific framework requests, please reach out to our <span className="doc__lt" onClick={() => window.openLTChatWidget()}>support team</span>.
50+
HyperExecute GUI is currently in **BETA** and supports the **Java TestNG Framework (with Java Version 11 or higher)**. We're actively working on expanding support to more frameworks. If you have specific framework requests, please reach out to our <span className="doc__lt" onClick={() => window.openLTChatWidget()}>support team</span>.
5151

5252
:::
5353

@@ -61,9 +61,11 @@ HyperExecute GUI is currently in **BETA** and supports the **Java TestNG Framewo
6161

6262
## Pre-Requisites
6363
---
64+
**1. HyperExecute Access** : You need a LambdaTest account to use the HyperExecute GUI. If you don’t have one, [sign up](https://accounts.lambdatest.com/register?) now. Ensure your account includes HyperExecute access (free or paid plan) to get started.
6465

65-
Before getting started, download the HyperExecute GUI installer from your LambdaTest dashboard and install it on your system. Run the installer by following the on-screen instructions and launch HyperExecute GUI from your applications menu.
66-
Currently HyperExecute GUI is a part of the **LambdaTest Underpass Application**. If you already have Underpass app on your system, please update it to latest version.
66+
**2. UnderPass App Download** : Before getting started, download the HyperExecute GUI installer from your LambdaTest dashboard and install it on your system. Run the installer by following the on-screen instructions and launch HyperExecute GUI from your applications menu.
67+
68+
Currently HyperExecute GUI is a part of the **LambdaTest UnderPass Application**. If you already have UnderPass app on your system, please update it to the latest version.
6769

6870
:::tip Download the GUI 🔗
6971
You can download the app directly from your **HyperExecute Dashboard** or simply click the links below based on your operating system:
@@ -72,22 +74,24 @@ You can download the app directly from your **HyperExecute Dashboard** or simply
7274
- **[Download for Linux](https://downloads.lambdatest.com/underpass/master/UnderPass.AppImage)**
7375
:::
7476

75-
## Getting Started in 4 Simple Steps
77+
## Demo Walkthrough
7678
---
79+
For those who prefer a hands-on, visual approach, we’ve created a comprehensive video tutorial to get you up and running quickly. Checkout this video demo which walks you through the step by step process of using the GUI App using a demo project.
7780

78-
### Demo Walkthrough
79-
80-
Please checkout this video demo which walks you through the step by step process of using the GUI App using a demo project. All the steps taken in this video are explained in detail in the following step by step guide too.
81+
All the steps taken in this video are explained in detail in the following step by step guide too.
8182

8283
<video class="right-side" width="100%" controls id="vid">
8384
<source src= {require('../assets/videos/hyperexecute/cli-gui/GUI_Demo.mp4').default} type="video/mp4" />
8485
</video>
8586

87+
## Getting Started
88+
---
89+
8690
### Step 1: Select and Analyze Your Project
8791
Launch the application, log in with your LambdaTest credentials, and select your test project folder. The GUI will automatically analyze your project i.e.:
8892

8993
- Detect your testing framework and language
90-
- Verify and manages network connectivity
94+
- Verifies network connectivity (enabling a tunnel if needed) and checks LambdaTest URL access (prompting for proxy settings if required)
9195
- Set up a secure connection to your account
9296

9397
:::tip Sample Project 🔗
@@ -130,6 +134,23 @@ Click on the **Run Test** button to start the test execution. A pop with job sta
130134
<source src= {require('../assets/videos/hyperexecute/cli-gui/demo_25.mp4').default} type="video/mp4" />
131135
</video>
132136

137+
## Already Using HyperExecute via YAML?
138+
---
139+
If you’re a HyperExecute YAML user, you can easily import your existing YAML configurations into the GUI. Here’s how:
140+
141+
#### 1. Pop-Up on First Upload:
142+
When you upload a project with YAML files, a pop-up will automatically appear listing the existing YAMLs in your project. Select a YAML file, and the app will import its settings for run config in the GUI.
143+
144+
#### 2. Option to Import After Project Creation:
145+
If your project is already set up or you want to update the run config using a YAML file later:
146+
- Go to the Project Details screen.
147+
- Click “Load Config.”
148+
- Choose a YAML file from your project, and its settings will be applied.
149+
150+
:::note
151+
The GUI converts your YAML (version 0.2) to its own format (version 0.3) automatically, so you don’t need to adjust it manually.
152+
:::
153+
133154
## FAQs
134155

135156
---

0 commit comments

Comments
 (0)