HYP CLI doc revamped

Author: amanchopra1905

docs/hyperexecute-cli-run-tests-on-hyperexecute-grid.md

@@ -1,7 +1,7 @@
 ---
 id: hyperexecute-cli-run-tests-on-hyperexecute-grid
 title: HyperExecute CLI - Run test on HyperExecute
-hide_title: true
+hide_title: false
 sidebar_label: HyperExecute CLI - Run test on HyperExecute
 description: Explains about HyperExecute CLI
 keywords:
@@ -24,6 +24,11 @@ site_name: LambdaTest
 slug: hyperexecute-cli-run-tests-on-hyperexecute-grid/
 ---
 
+import CodeBlock from '@theme/CodeBlock';
+import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
        "@context": "https://schema.org",
@@ -47,32 +52,24 @@ slug: hyperexecute-cli-run-tests-on-hyperexecute-grid/
       })
     }}
 ></script>
-
-
-# HyperExecute CLI 
-
 `HyperExecute CLI` is a command line interface that is required to run tests on HyperExecute. This page outlines all you need to know about the CLI and also explains about the different flags & functionalities supported by the HyperExecute CLI.
 
-***
-
-### Downloading the HyperExecute CLI
+## Download the HyperExecute CLI
 
 You can download the `HyperExecute CLI` for your OS from the links given below :
 
 | Platform | Download Link |
 | ---------| --------------------------- |
+| Linux | https://downloads.lambdatest.com/hyperexecute/linux/hyperexecute |
 | Windows | https://downloads.lambdatest.com/hyperexecute/windows/hyperexecute.exe |
 | macOS | https://downloads.lambdatest.com/hyperexecute/darwin/hyperexecute |
-| Linux | https://downloads.lambdatest.com/hyperexecute/linux/hyperexecute |
 
 ## HyperExecute CLI Supported Flags 
 
 HyperExecute CLI provides different command-line flags that let you control the HyperExecute platform as per your customised requirements. You can run `hyperexecute.exe --help` on your terminal to explore the different flags.
 
 <img loading="lazy" src={require('../assets/images/hyperexecute/cli/cli-help.png').default} alt="Image"  className="doc_img"/>
 
-***
-
 The various flags that are supported are listed below. 
 
 | Flags | Type | Description
@@ -288,15 +285,22 @@ The secrets file contains highly sensitive information and must be strictly excl
 
 ***
 
-## Running HyperExecute CLI 
+## Trigger your Test from HyperExecute CLI 
 
-In order to trigger your test on Hyperexecute, just need to use the following command. Please replace the placeholder values with your details. 
+In order to trigger your job on HyperExecute, execute the following command in your terminal. You will need to insert the name of your YAML file in place of the `YOUR_YAML_FILE` before running this command.
 
-``` bash
-./hyperexecute --user <your_username> --key <your_access_key> --config <your_yaml_file_name>
-```
+  <div className="lambdatest__codeblock">
+    <CodeBlock className="language-bash">
+  {`./hyperexecute --user ${ YOUR_LAMBDATEST_USERNAME()} --key ${ YOUR_LAMBDATEST_ACCESS_KEY()} --config YOUR_YAML_FILE `}
+    </CodeBlock>
+  </div>
 
-> **Note**: If you're running on a minimal alpine image, please make sure to install essential linux dependencies for HyperExecute CLI to work. 
+:::tip
+In case of macOS, if you get a permission denied warning while executing CLI, simply run `chmod u+x ./hyperexecute` to allow permission. In case you get a security popup, allow it from your **System Preferences** → **Security & Privacy** → **General** tab.
+:::
+
+:::note
+If you're running on a minimal alpine image, please make sure to install essential linux dependencies for HyperExecute CLI to work. 
 (An example with our sample repo has been given below):
   ``` bash
   apk add libc6-compat git bash
@@ -306,44 +310,35 @@ In order to trigger your test on Hyperexecute, just need to use the following co
   chmod +x hyperexecute
   ./hyperexecute --user <lt_user> --key <lt_access_key> --config yaml/win/behave_hyperexecute_autosplit_sample.yaml
   ```
-
-*** 
-
-### `.gitignore` & `.hyperexecuteignore` 
-
-The HyperExecute CLI binary ignores all the files listed in the `.gitignore` file during the testing process. 
-
-We also provide a similar functionality using te `.hyperexecuteignore`. [Learn More](/support/docs/hyperexecute-gitignore/)
-
-> Feel free to go over the [frequently asked questions](/support/docs/hyperexecute-cli-faqs/) about the HyperExecute CLI.
+:::
 
 ## Running HyperExecute CLI in Quiet Mode
 
-Each time a job is run in Hyperexecute, a large number of logs are produced. These logs are sometimes beneficial for thorough debugging and analysis, it occasionally overwhelms Continuous Integration (CI) systems with an excessive amount of logs, especially when handling a large number of test executions. Hyperexecute provides a **"Quiet mode"** as a solution to this issue and to give users more control over the logging output. By only displaying significant updates during the test execution, this enables you to run tests with less logs.
-
-### Enabling Quiet Mode using CLI
-First, you need to paas these commands in CLI or terminal to enable the **Quiet Mode** and then trigger the command to execute your job.
-
-For macOS / Linux:
-
-```bash
-env | grep CI
-# Used to check if the CI variable is set to true or not
+Each time a job is run in Hyperexecute, a large number of logs are produced. These logs are sometimes beneficial for thorough debugging and analysis, it occasionally overwhelms Continuous Integration (CI) systems with an excessive amount of logs, especially when handling a large number of test executions.
 
-export CI=true
-# If it's not set to true, then use this command to set as true
-```
+Hyperexecute provides a **"Quiet mode"** as a solution to this issue and to give users more control over the logging output. By only displaying significant updates during the test execution, this enables you to run tests with less logs.
 
-For Windows:
+To enable the **Quiet Mode**, you need to paas these commands in your terminal and then trigger the command to execute your job.
 
-```bash
-env | grep CI
-# Used to check if the CI variable is set to true or not
+<Tabs className="docs__val">
+<TabItem value="bash" label="Linux / macOS" default>
+  ```yaml
+  env | grep CI # Used to check if the CI variable is set to true or not
+  export CI=true # If it's not set to true, then use this command to set as true
+  ```
+</TabItem>
 
-set CI=true
-# If it's not set to true, then use this command to set as true
-```
+<TabItem value="powershell" label="Windows" default>
+  ```yaml
+  env | grep CI # Used to check if the CI variable is set to true or not
+  set CI=true # If it's not set to true, then use this command to set as true
+  ```
+</TabItem>
+</Tabs>
 
 #### Output
 
 <img loading="lazy" src={require('../assets/images/hyperexecute/cli/cli-execute.png').default} alt="Image" width="1350" height="619" className="doc_img"/>
+<br /><br />
+> 📕 Use the HyperExecute CLI's [Frequently Asked Questions](/support/docs/hyperexecute-cli-faqs/) to gain more knowledge about it.
+

docs/hyperexecute-inherit-config.md

@@ -41,15 +41,13 @@ YAML inheritance in HyperExecute allows you to reuse common configuration settin
 
 For example, you can create a base YAML file with common settings like **browsers**, **OS versions**, and **devices**, and then inherit from it in other YAML files for different environments or test types. This **reduces boilerplate code and errors** while making it easy to switch between environments and manage complex test execution configurations.
 
-### Prerequisites
+## Prerequisites
 
 -   You must inherit a YAML file of the same version as your original file.
-    
 -   The mode of execution, i.e. Matrix, AutoSplit, or Hybrid, must remain the same in both of the YAML files.
-    
 -   The files that you want to inherit cannot be cyclically dependent. If you want to inherit **A.yaml** in **B.yaml**, then **A.yaml** cannot inherit **B.yaml**.
 
-### How do you use the Inheritance feature?
+## How do you use the Inheritance feature?
 
 You can use the inheritance feature by entering the following flag in your YAML file:
 
@@ -69,22 +67,22 @@ base:
 
 Go through the example attached below to understand how the resultant YAML will function if you inherit a base YAML in your parent YAML file. 
 
-**Parent YAML**:
+### Parent YAML
+
 ```yaml
 ---
 version: 0.1
-testSuiteTimeout: 10
-testSuiteStep: 8
+runson: win
 
 base:
   yamls:
     - ./level1/base1.yaml
 
-runson: win
 autosplit: true
+concurrency: 2
+
 retryOnFailure: false
 maxRetries: 5
-concurrency: 2
 
 env:
   CACHE_DIR: m2_cache_dir
@@ -96,6 +94,12 @@ preDirectives:
     - echo yaml/level0/level1/base1.yaml
     - mvn dependency:resolve
 
+testDiscovery:
+  type: raw
+  command: grep 'test name' xml/testng_win.xml | awk '{print$2}' | sed 's/name=//g' | sed 's/\x3e//g'
+
+testRunnerCommand: mvn test `-Dplatname=win `-Dmaven.repo.local=./.m2 dependency:resolve `-DselectedTests=$test
+
 postDirectives:
   commands:
     - ls
@@ -108,26 +112,20 @@ uploadArtefacts:
    path:
     - target/surefire-reports/html/**
 
-testDiscovery:
-  type: raw
-  command: grep 'test name' xml/testng_win.xml | awk '{print$2}' | sed 's/name=//g' | sed 's/\x3e//g'
-
-testRunnerCommand: mvn test `-Dplatname=win `-Dmaven.repo.local=./.m2 dependency:resolve `-DselectedTests=$test
+jobLabel: ['parent']
 ```
 
-**Base YAML**: 
+### Base YAML
 ```yaml
 ---
 version: 0.1
-testSuiteTimeout: 10
-testSuiteStep: 0
-
-
 runson: mac
+
 autosplit: true
+concurrency: 1
+
 retryOnFailure: true
 maxRetries: 5
-concurrency: 1
 
 env:
   CACHE_DIR: m2_cache_dir
@@ -137,6 +135,12 @@ preDirectives:
     - pwd
     - mvn dependency:resolve
 
+testDiscovery:
+  type: raw
+  mode: static
+
+testRunnerCommand: echo test
+
 postDirectives:
   commands:
     - ls
@@ -149,29 +153,20 @@ uploadArtefacts:
    path:
     - target/surefire-reports/html/**
 
-testDiscovery:
-  type: raw
-  mode: static
-
-testRunnerCommand: echo test
-
 jobLabel: ['base1']
 ```
 
-
-**Resultant YAML**: 
+### Resultant YAML
 ```yaml
 ---
 version: 0.1
-testSuiteTimeout: 10
-testSuiteStep: 8
-
-
 runson: mac
+
 autosplit: true
+concurrency: 1
+
 retryOnFailure: true
 maxRetries: 5
-concurrency: 1
 
 env:
   CACHE_DIR: m2_cache_dir
@@ -181,6 +176,13 @@ preDirectives:
     - pwd
     - mvn dependency:resolve
 
+testDiscovery:
+  type: raw
+  mode: static
+  command: grep 'test name' xml/testng_win.xml | awk '{print$2}' | sed 's/name=//g' | sed 's/\x3e//g'
+
+testRunnerCommand: mvn test `-Dplatname=win `-Dmaven.repo.local=./.m2 dependency:resolve `-DselectedTests=$test
+
 postDirectives:
   commands:
     - ls
@@ -193,13 +195,6 @@ uploadArtefacts:
    path:
     - target/surefire-reports/html/**
 
-testDiscovery:
-  type: raw
-  mode: static
-  command: grep 'test name' xml/testng_win.xml | awk '{print$2}' | sed 's/name=//g' | sed 's/\x3e//g'
-
-testRunnerCommand: mvn test `-Dplatname=win `-Dmaven.repo.local=./.m2 dependency:resolve `-DselectedTests=$test
-
 jobLabel: ['base1']
 
 ```

docs/hyperexecute-running-your-first-job.md

@@ -113,7 +113,7 @@ The generic command required to initiate test execution is given below. You will
 
   <div className="lambdatest__codeblock">
     <CodeBlock className="language-bash">
-  {`./hyperexecute --user="${ YOUR_LAMBDATEST_USERNAME()}" --key "${ YOUR_LAMBDATEST_ACCESS_KEY()}" --config "YOUR_YAML_FILE" `}
+  {`./hyperexecute --user ${ YOUR_LAMBDATEST_USERNAME()} --key ${ YOUR_LAMBDATEST_ACCESS_KEY()} --config "YOUR_YAML_FILE" `}
     </CodeBlock>
   </div>