wdio-lambdatest-service-sdk 5.1.5 → 5.1.7

package/README.md

@@ -1,6 +1,6 @@
-# WDIO LambdaTest Service
+# WDIO LambdaTest CLI
 
-WebdriverIO service and CLI for running Appium and browser tests on [LambdaTest](https://www.lambdatest.com). This SDK handles authentication, test status updates on the LambdaTest dashboard, and provides an interactive CLI to generate and setup WDIO configs that connect directly to LambdaTest automation.
+CLI for running WebdriverIO and Appium tests on [LambdaTest](https://www.lambdatest.com). Use the CLI to generate or update WDIO configs that connect to LambdaTest (auth, capabilities, test status updates).
 
 ---
 
@@ -8,14 +8,14 @@ WebdriverIO service and CLI for running Appium and browser tests on [LambdaTest]
 
 - [Features](#features)
 - [Installation](#installation)
-- [Try the SDK / CLI with the Sample Project](#try-the-sdk--cli-with-the-sample-project)
+- [Generate Config (recommended)](#generate-config-recommended)
+- [CLI Commands](#cli-commands)
+- [Try the CLI with the Sample Project](#try-the-cli-with-the-sample-project)
 - [Steps to Run the Sample Project](#steps-to-run-the-sample-project)
 - [Specs Folder & Code Design](#specs-folder--code-design)
-- [Generate Config That Connects to LT Automation](#generate-config-that-connects-to-lt-automation)
-- [CLI Commands](#cli-commands)
-- [Automated Setup](#automated-setup)
-- [Config Generator](#config-generator)
+- [Setup Command](#setup-command)
 - [Manual Configuration](#manual-configuration)
+- [Troubleshooting](#troubleshooting)
 - [Development](#development)
 - [License](#license)
 
@@ -23,11 +23,10 @@ WebdriverIO service and CLI for running Appium and browser tests on [LambdaTest]
 
 ## Features
 
-- **Authentication**: Pass `username` and `accessKey` in the service options or via the CLI.
-- **Test Status Updates**: Automatically marks tests as Passed/Failed on the LambdaTest dashboard using Lambda Hooks.
-- **Logs**: Clean, colorful status logs in the terminal.
-- **CLI**: Interactive config generator and setup tool (Commander, Chalk, Inquirer; runs with Node.js or Bun).
-- **Multi-select**: Choose multiple test types, device types, platforms, and app/website targets in one config.
+- **CLI**: Interactive config generator (`wdio-lt generate`) and setup (`wdio-lt setup`) for existing projects.
+- **Generate**: Multi-select for test type, device type, platform, app/website; creates `LT_Test/<name>.conf.js` ready to run.
+- **Setup**: Injects LambdaTest service into existing `*.conf.js` files.
+- **Auth & status**: Generated/setup configs use your credentials and report test status to the LambdaTest dashboard.
 
 ---
 
@@ -36,320 +35,273 @@ WebdriverIO service and CLI for running Appium and browser tests on [LambdaTest]
 Works with **Node.js** (≥18) or **Bun** (≥1.0). No Bun required.
 
 ```bash
-# With npm (Node.js)
-npm install wdio-lambdatest-service --save-dev
+# Install the CLI (npm)
+npm i wdio-lambdatest-service-sdk --save-dev
 
-# With Bun (optional)
-bun add wdio-lambdatest-service --dev
+# Or with Bun
+bun add wdio-lambdatest-service-sdk --dev
 ```
 
 ### Peer dependency conflict (ERESOLVE)
 
-If you see `ERESOLVE unable to resolve dependency tree` because your project uses **WebdriverIO 5 or 6** and the installed package expects a different major version, use one of these:
-
-**Option 1 – Install and allow peer mismatch (recommended):**
+If you see `ERESOLVE unable to resolve dependency tree` (e.g. WebdriverIO 5 or 6), use:
 
 ```bash
-npm install wdio-lambdatest-service --save-dev --legacy-peer-deps
+npm i wdio-lambdatest-service-sdk --save-dev --legacy-peer-deps
 ```
 
-**Option 2 – Force install:**
+Or:
 
 ```bash
-npm install wdio-lambdatest-service --save-dev --force
+npm i wdio-lambdatest-service-sdk --save-dev --force
 ```
 
-This package declares support for **@wdio/cli** and **webdriverio** `^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0 || ^9.0.0`. If you are on an older published version of the service that had stricter peer deps, upgrade to the latest version or use `--legacy-peer-deps` until you can upgrade.
-
 ---
 
-## Try the SDK / CLI with the Sample Project
+## Generate Config (recommended)
 
-To verify the SDK and CLI work end-to-end, clone the official LambdaTest sample project and run tests using this service.
+Use the CLI to generate a WDIO config that is already wired to LambdaTest.
 
-### 1. Clone the Sample Repository
+### 1. Install the CLI
 
 ```bash
-git clone https://github.com/LambdaTest/LT-appium-nodejs-webdriverio
-cd LT-appium-nodejs-webdriverio
+npm i wdio-lambdatest-service-sdk --save-dev
 ```
 
-This repo contains:
-
-- **android-sample/** – WebdriverIO + Appium configs and scripts for Android (real/virtual).
-- **ios-sample/** – WebdriverIO + Appium configs and scripts for iOS.
-- **specs/** – Shared test specs (e.g. `android-test.js`, `ios-test.js`) used by both samples.
-
-### 2. Install the WDIO LambdaTest Service (SDK)
-
-From the **repo root** (or from inside `android-sample` / `ios-sample` if you prefer):
+### 2. Run the generator
 
 ```bash
-# From repo root – install SDK as dev dependency
-npm install ./wdio-lambdatest-service --save-dev
-# or, if the SDK is published:
-npm install wdio-lambdatest-service
+npx wdio-lt generate
 ```
 
-### 3. Set LambdaTest Credentials
-
-Export your [LambdaTest](https://accounts.lambdatest.com) username and access key:
-
-**Linux / macOS:**
+Or with Bun:
 
 ```bash
-export LT_USERNAME="your_username"
-export LT_ACCESS_KEY="your_access_key"
+bunx wdio-lt generate
 ```
 
-**Windows (CMD):**
+### 3. Follow the prompts
 
-```cmd
-set LT_USERNAME=your_username
-set LT_ACCESS_KEY=your_access_key
-```
+- **Test name** – Build name and config filename.
+- **LambdaTest Username & Access Key** – Or use `LT_USERNAME` / `LT_ACCESS_KEY`.
+- **Test type(s)** – App Testing and/or Browser Testing (multi-select).
+- **Device type(s)** – Real / Virtual (multi-select).
+- **Platform(s)** – Android / iOS (multi-select).
+- **What to test** – Application (Native App) / Website (Mobile Browser) (multi-select).
+- **App ID(s)** – Per platform if native app (e.g. `lt://proverbial-android`).
+- **Parallel threads** – 0 for sequential.
+- **Spec file path** – e.g. `../specs/android-test.js` (relative to config dir).
 
-**Windows (PowerShell):**
+### 4. Output
 
-```powershell
-$env:LT_USERNAME = "your_username"
-$env:LT_ACCESS_KEY = "your_access_key"
-```
+- **Config:** `LT_Test/<TestName>.conf.js`
+- **Script in** `LT_Test/package.json`: `test:<TestName>`
 
-### 4. Run the Sample Project
+### 5. Run
 
-See [Steps to Run the Sample Project](#steps-to-run-the-sample-project) below for detailed run commands (single/parallel, Android/iOS).
+```bash
+cd LT_Test
+npm run test:<TestName>
+```
 
 ---
 
-## Steps to Run the Sample Project
+## CLI Commands
 
-After cloning [LT-appium-nodejs-webdriverio](https://github.com/LambdaTest/LT-appium-nodejs-webdriverio) and setting credentials:
+| Command | Description |
+|--------|-------------|
+| `wdio-lt generate` | Interactively generate a new WDIO config for LambdaTest |
+| `wdio-lt init` | Alias for `generate` |
+| `wdio-lt setup [path]` | Inject LambdaTest service into existing WDIO config files |
+| `wdio-lt --help` | Show help |
+| `wdio-lt --version` | Show version |
 
-### Android
+### Full usage (all commands)
+
+**With npx (Node.js):**
 
 ```bash
-cd android-sample
-npm install
-# Single test
-npm run SingleAndroidApp
-# Or run parallel (if defined in package.json)
-npm run parallel
+# Show help and version
+npx wdio-lt --help
+npx wdio-lt -h
+npx wdio-lt --version
+npx wdio-lt -v
+
+# Generate – create a new WDIO config (interactive)
+npx wdio-lt generate
+npx wdio-lt gen
+npx wdio-lt init
+
+# Setup – inject LambdaTest service into existing configs
+npx wdio-lt setup
+npx wdio-lt setup .
+npx wdio-lt setup ./android-sample
+npx wdio-lt setup ./path/to/your/project
 ```
 
-### iOS
+**With Bun:**
 
 ```bash
-cd ios-sample
-npm install
-# Single test (script name may vary, e.g. SingleIosApp)
-npm run single
-# Or run parallel
-npm run parallel
+bunx wdio-lt --help
+bunx wdio-lt --version
+bunx wdio-lt generate
+bunx wdio-lt gen
+bunx wdio-lt init
+bunx wdio-lt setup
+bunx wdio-lt setup ./android-sample
 ```
 
-**Note:** Ensure config files in `android-sample` and `ios-sample` point to the correct spec paths (e.g. `../specs/android-test.js`, `../specs/ios-test.js`) and that the WDIO LambdaTest service is registered in `services` in those configs. Test results appear in the terminal and on the [LambdaTest App Automation Dashboard](https://appautomation.lambdatest.com/).
+**Using the installed binary (after `npm i wdio-lambdatest-service-sdk --save-dev`):**
 
----
-
-## Specs Folder & Code Design
+```bash
+# From project root (node_modules/.bin in PATH)
+wdio-lt --help
+wdio-lt --version
+wdio-lt generate
+wdio-lt init
+wdio-lt setup
+wdio-lt setup ./android-sample
 
-The sample repo uses a **shared `specs/` folder** at the root so both Android and iOS (and any generated configs) can reuse the same test files.
+# Or via npm run (add to package.json "scripts")
+npm run lt:generate    # "lt:generate": "wdio-lt generate"
+npm run lt:setup       # "lt:setup": "wdio-lt setup ./android-sample"
+```
 
-Recommended layout (align with the sample repo):
+**Alternative binary name (same CLI):**
 
-```
-LT-appium-nodejs-webdriverio/
-├── android-sample/
-│   ├── conf/                 # or *.conf.js in root of android-sample
-│   │   └── android.conf.js
-│   ├── package.json
-│   └── ...
-├── ios-sample/
-│   ├── conf/
-│   │   └── ios.conf.js
-│   ├── package.json
-│   └── ...
-├── specs/                    # Shared test specs
-│   ├── android-test.js
-│   ├── ios-test.js
-│   └── (your own specs)
-├── wdio-lambdatest-service/  # This SDK (if developed locally)
-└── package.json
+```bash
+npx wdio-lambdatest generate
+npx wdio-lambdatest setup ./android-sample
 ```
 
-**Design guidelines:**
+**Legacy commands (backward compatible):**
 
-- **One spec file per flow or platform** (e.g. `android-test.js`, `ios-test.js`, `web-test.js`) so configs can reference them clearly.
-- **Use `specs: ["../specs/android-test.js"]`** (or similar relative path) in configs under `android-sample` so they point to the shared `specs/` folder.
-- **Keep assertions and page interactions in the specs**; keep capabilities and environment in the config files.
-- **Reuse the same spec** across different configs (e.g. single device vs parallel) by only changing the config, not the spec.
-
-Following this structure makes it easy to add new configs (including those generated by `wdio-lt generate`) that point to the same `specs/` folder.
+```bash
+npx wdio-lambdatest-setup ./android-sample
+npx wdio-lambdatest-generator
+```
 
 ---
 
-## Generate Config That Connects to LT Automation
-
-Use the CLI to generate a WDIO config that is **already wired to LambdaTest** (hostname, path, services, and capabilities).
-
-### 1. Install the CLI
+## Try the CLI with the Sample Project
 
-If the SDK is in the repo:
+1. **Clone the sample repo**
 
 ```bash
+git clone https://github.com/LambdaTest/LT-appium-nodejs-webdriverio
 cd LT-appium-nodejs-webdriverio
-npm install ./wdio-lambdatest-service --save-dev
 ```
 
-Or install from npm (when published):
+2. **Install the CLI**
 
 ```bash
-npm install wdio-lambdatest-service --save-dev
+npm i wdio-lambdatest-service-sdk --save-dev
 ```
 
-### 2. Run the Config Generator
+3. **Set credentials**
 
-```bash
-# With Node.js
-npx wdio-lt generate
+**Linux / macOS:**
 
-# With Bun (optional)
-bunx wdio-lt generate
+```bash
+export LT_USERNAME="your_username"
+export LT_ACCESS_KEY="your_access_key"
 ```
 
-### 3. Follow the Prompts
-
-- **Test name** – Used for build name and config filename.
-- **LambdaTest Username & Access Key** – Stored in the generated config (or use env vars and leave blank if you rely on `LT_USERNAME` / `LT_ACCESS_KEY`).
-- **Test type(s)** – App Testing (Mobile) and/or Browser Testing (Desktop). You can select multiple.
-- **Device type(s)** – Real Device, Virtual Device (for App Testing). Multi-select.
-- **Platform(s)** – Android, iOS. Multi-select.
-- **What do you want to test?** – Application (Native App), Website (Mobile Browser). Multi-select.
-- **App ID(s)** – If you chose native app, enter the App URL (e.g. `lt://APP123456789`) per platform; you can use sample apps (e.g. `lt://proverbial-android`, `lt://proverbial-ios`).
-- **Parallel threads** – 0 for sequential, or a number for parallel.
-- **Spec file path** – Path to your test file, e.g. `./specs/test.js` or `../specs/android-test.js` relative to the generated config location.
-
-### 4. Generated Output
-
-The CLI writes:
+**Windows (PowerShell):**
 
-- **Config file:** `LT_Test/<TestName>.conf.js` – Ready to run against LambdaTest (hostname, path, services, and capabilities set).
-- **Package script:** In `LT_Test/package.json`, a script like `test:<TestName>` is added.
+```powershell
+$env:LT_USERNAME = "your_username"
+$env:LT_ACCESS_KEY = "your_access_key"
+```
 
-### 5. Run the Generated Config
+4. **Generate a config and run**
 
 ```bash
-cd LT_Test
-npm install   # if needed
-npm run test:<TestName>
-# or
-npx wdio <TestName>.conf.js
+npx wdio-lt generate
+cd LT_Test && npm run test:<TestName>
 ```
 
-To follow the same code design as the sample repo, set the **spec file path** during `wdio-lt generate` to your existing `specs/` folder, e.g. `../specs/android-test.js`, so the generated config reuses your shared specs.
+Or run the existing samples: see [Steps to Run the Sample Project](#steps-to-run-the-sample-project).
 
 ---
 
-## CLI Commands
-
-| Command | Description |
-|--------|-------------|
-| `wdio-lt setup [path]` | Inject LambdaTest service into existing WDIO config files |
-| `wdio-lt generate` | Interactively generate a new WDIO config for LambdaTest |
-| `wdio-lt init` | Alias for `generate` |
-| `wdio-lt --help` | Show help |
-| `wdio-lt --version` | Show version |
-
-### Examples
-
-```bash
-# Setup – inject service into all .conf.js files in a directory
-wdio-lt setup ./android-sample
-
-# Setup – interactive mode (prompts for directory)
-wdio-lt setup
-
-# Generate – create a new config interactively
-wdio-lt generate
-```
+## Steps to Run the Sample Project
 
-### Running the CLI
+After cloning [LT-appium-nodejs-webdriverio](https://github.com/LambdaTest/LT-appium-nodejs-webdriverio) and setting credentials:
 
-**With Node.js** (default; no extra install):
+### Android
 
 ```bash
-npx wdio-lt setup ./android-sample
-npx wdio-lt generate
+cd android-sample
+npm install
+npm run SingleAndroidApp
+# or: npm run parallel
 ```
 
-**With Bun** (optional; faster):
+### iOS
 
 ```bash
-curl -fsSL https://bun.sh/install | bash   # Install Bun
-bunx wdio-lt setup ./android-sample
-bunx wdio-lt generate
+cd ios-sample
+npm install
+npm run single
+# or: npm run parallel
 ```
 
-### Legacy Commands (backward compatible)
-
-```bash
-wdio-lambdatest-setup ./android-sample
-wdio-lambdatest-generator
-```
+Ensure configs point to the correct spec paths (e.g. `../specs/android-test.js`) and include the LambdaTest service. Results appear in the terminal and on the [LambdaTest App Automation Dashboard](https://appautomation.lambdatest.com/).
 
 ---
 
-## Automated Setup
+## Specs Folder & Code Design
 
-The `setup` command updates existing WebdriverIO config files (`*.conf.js`) to use this SDK:
+The sample repo uses a shared **`specs/`** folder at the root. Use the same layout so generated configs can reuse specs.
 
-```bash
-wdio-lt setup ./path/to/your/project
-```
+Recommended layout:
 
-It will:
+```
+LT-appium-nodejs-webdriverio/
+├── android-sample/
+├── ios-sample/
+├── specs/              # Shared test specs
+│   ├── android-test.js
+│   ├── ios-test.js
+│   └── ...
+├── LT_Test/            # Generated configs (from wdio-lt generate)
+└── package.json
+```
 
-- Scan for `.conf.js` files recursively.
-- Inject the service configuration.
-- Set `logLevel` to `error` for cleaner output.
-- Comment out hardcoded credentials so the SDK can use env vars or service options.
+- Use paths like `../specs/android-test.js` in configs under `LT_Test` or sample dirs.
+- When running `wdio-lt generate`, set the spec path to e.g. `../specs/android-test.js` so the generated config uses the shared specs.
 
 ---
 
-## Config Generator
+## Setup Command
 
-The `generate` command creates a new WDIO config with interactive prompts:
+Use the CLI to add the LambdaTest service to existing WDIO configs:
 
 ```bash
-wdio-lt generate
+wdio-lt setup ./path/to/your/project
 ```
 
-Features:
+This will:
 
-- Test name with validation
-- LambdaTest username and access key (secure input)
-- **Multi-select:** Test type(s), Device type(s), Platform(s), What to test (App / Website)
-- App ID(s) per platform when testing native apps
-- Parallel threads and spec file path with smart resolution
-
-Generated configs are saved to `./LT_Test/<testName>.conf.js`.
+- Find `*.conf.js` files recursively.
+- Add the service configuration.
+- Set `logLevel` to `error`.
+- Comment out hardcoded credentials so env vars or service options are used.
 
 ---
 
 ## Manual Configuration
 
-Add the service to your `wdio.conf.js`:
+If you prefer not to use the CLI, add the service to your `wdio.conf.js`:
 
 ```javascript
 const path = require('path');
 
 exports.config = {
-    // user / key can be omitted if using service options or env
     logLevel: 'error',
-
     services: [
-        [path.join(__dirname, 'node_modules/wdio-lambdatest-service'), {
+        [path.join(__dirname, 'node_modules/wdio-lambdatest-service-sdk'), {
             user: process.env.LT_USERNAME,
             key: process.env.LT_ACCESS_KEY
         }]
@@ -358,47 +310,53 @@ exports.config = {
 };
 ```
 
-If using the SDK from a local path (e.g. repo root):
+Prefer using **`wdio-lt generate`** or **`wdio-lt setup`** so paths and specs are set correctly.
 
-```javascript
-    services: [
-        [path.join(__dirname, '../wdio-lambdatest-service'), {
-            user: process.env.LT_USERNAME,
-            key: process.env.LT_ACCESS_KEY
-        }]
-    ],
-```
+---
+
+## Troubleshooting
+
+- **"Cannot read properties of null (reading 'launcher')"** or **"No specs found"**  
+  Regenerate or fix the config with the CLI so the service path and spec paths are correct:
+  - Run `npx wdio-lt generate` and use the new config, or
+  - Run `npx wdio-lt setup ./path/to/project` to re-inject the service.
+  - Ensure **specs** in the config point to existing files (e.g. `../specs/android-test.js` from `LT_Test`).
+
+- **ERESOLVE / peer dependency errors**  
+  Install with `--legacy-peer-deps` or `--force` (see [Installation](#installation)).
+
+- **Wrong or missing spec path**  
+  When generating, use a path relative to the config file (e.g. `../specs/android-test.js`). Re-run `wdio-lt generate` if needed.
 
 ---
 
 ## Development
 
-This package provides a **Service** (worker) and a **Launcher** (main process) for WebdriverIO.
+This package ships a **CLI** (`wdio-lt`) and a WebdriverIO service/launcher used by generated and setup configs.
 
-### Project Structure
+### Project structure
 
 ```
 wdio-lambdatest-service/
 ├── bin/
-│   ├── cli.js              # Main CLI entry (Commander)
-│   ├── setup.js            # Setup command wrapper
-│   └── generate-config.js  # Generate command wrapper
-├── lib/
-│   └── cli/
-│       ├── style.js        # Chalk style utilities
-│       ├── setup.js        # Setup logic
-│       └── generate.js     # Generate logic (Inquirer prompts)
+│   ├── cli.js
+│   ├── setup.js
+│   └── generate-config.js
+├── lib/cli/
+│   ├── setup.js
+│   ├── generate.js
+│   └── style.js
 ├── src/
-│   ├── launcher.js         # WDIO Launcher
-│   └── service.js          # WDIO Service
-├── index.js                # Main entry point
+│   ├── launcher.js
+│   └── service.js
+├── index.js
 └── package.json
 ```
 
 ### Requirements
 
-- **Node.js**: >= 18.0.0 (required for npm install and default CLI run)
-- **Bun**: >= 1.0.0 (optional; use `bun add` / `bunx wdio-lt` for faster install and run)
+- **Node.js**: >= 18.0.0
+- **Bun**: >= 1.0.0 (optional)
 
 ---
 

package/bin/cli.js

@@ -1,56 +1,42 @@
 #!/usr/bin/env node
 /**
- * LambdaTest WDIO CLI - Unified command-line interface.
+ * TestMU WDIO CLI - Unified command-line interface.
  * Powered by Commander, Chalk, and Inquirer.
  * Runs with Node.js or Bun.
  */
 const { Command } = require('commander');
 const chalk = require('chalk');
+const { welcomeBanner, infoBox } = require('../lib/cli/style');
 const { runSetup } = require('../lib/cli/setup');
 const { runGenerate } = require('../lib/cli/generate');
 const pkg = require('../package.json');
 
 const program = new Command();
 
-// ASCII Art Logo
-const logo = `
-${chalk.cyan('╔═══════════════════════════════════════════════════════════╗')}
-${chalk.cyan('║')}  ${chalk.bold.white('🚀 LambdaTest WDIO CLI')}                                   ${chalk.cyan('║')}
-${chalk.cyan('║')}  ${chalk.dim('Fast, powerful WebdriverIO configuration tool')}            ${chalk.cyan('║')}
-${chalk.cyan('╚═══════════════════════════════════════════════════════════╝')}
-`;
-
 program
     .name('wdio-lt')
-    .description(chalk.dim('LambdaTest WebdriverIO CLI - Setup and configure WDIO projects'))
+    .description(chalk.dim('TestMU WebdriverIO CLI - Setup and configure WDIO projects for LambdaTest'))
     .version(pkg.version, '-v, --version', 'Display version number')
     .helpOption('-h, --help', 'Display help for command')
-    .addHelpText('before', logo)
+    .addHelpText('before', welcomeBanner())
     .addHelpText('after', `
-${chalk.bold('Examples:')}
+
+${chalk.bold('Examples')}
+  ${chalk.green('$')} wdio-lt generate                 ${chalk.dim('# Create new config (recommended)')}
+  ${chalk.green('$')} wdio-lt init                     ${chalk.dim('# Alias for generate')}
   ${chalk.green('$')} wdio-lt setup ./android-sample   ${chalk.dim('# Inject service into configs')}
   ${chalk.green('$')} wdio-lt setup                    ${chalk.dim('# Interactive mode')}
-  ${chalk.green('$')} wdio-lt generate                 ${chalk.dim('# Create new config')}
-  ${chalk.green('$')} wdio-lt init                     ${chalk.dim('# Alias for generate')}
 
-${chalk.bold('Documentation:')}
-  ${chalk.cyan('https://github.com/LambdaTest')}
-`);
+${infoBox('CLI preview', [
+    'npx wdio-lt              → show this help',
+    'npx wdio-lt generate     → interactive config generator',
+    'npx wdio-lt setup [path]  → add LambdaTest to existing configs'
+])}
 
-// Setup command
-program
-    .command('setup [path]')
-    .description('Inject LambdaTest service into existing WDIO config files')
-    .action(async (targetPath) => {
-        try {
-            await runSetup(targetPath);
-        } catch (e) {
-            console.error(chalk.red.bold('\n✖ Error:'), e.message);
-            process.exit(1);
-        }
-    });
+${chalk.dim('Documentation:')} ${chalk.cyan('https://github.com/LambdaTest')}
+`);
 
-// Generate command
+// Generate command (first / primary)
 program
     .command('generate')
     .alias('gen')
@@ -77,6 +63,19 @@ program
         }
     });
 
+// Setup command
+program
+    .command('setup [path]')
+    .description('Inject LambdaTest service into existing WDIO config files')
+    .action(async (targetPath) => {
+        try {
+            await runSetup(targetPath);
+        } catch (e) {
+            console.error(chalk.red.bold('\n✖ Error:'), e.message);
+            process.exit(1);
+        }
+    });
+
 // Parse arguments
 program.parse();
 

package/index.js

@@ -1,17 +1,17 @@
 /**
  * WDIO LambdaTest service entry point.
- * Exposes the service class and launcher for WebdriverIO.
- * Export shape supports both CommonJS and WDIO plugin resolution (default + launcher).
+ * Export shape: object with default (worker service) and launcher (main process)
+ * so @wdio/utils initialisePlugin never sees null when reading .launcher or .default.
  */
 const LambdaTestService = require('./src/service');
 const LambdaTestLauncher = require('./src/launcher');
 
-// Primary export: the worker service class (used by WDIO in worker process)
 const Service = LambdaTestService;
-
-// Attach launcher so WDIO can read plugin.launcher (main process)
 Service.launcher = LambdaTestLauncher;
-// ESM interop: some loaders expect plugin.default
 Service.default = Service;
 
-module.exports = Service;
+// Export object so require() never returns null and plugin.launcher / plugin.default always exist
+module.exports = {
+    default: Service,
+    launcher: LambdaTestLauncher
+};

package/lib/cli/generate.js

@@ -6,6 +6,9 @@ const path = require('path');
 const chalk = require('chalk');
 const inquirer = require('inquirer');
 
+// Support both CJS and ESM inquirer (default.prompt vs prompt)
+const prompt = (inquirer.default && inquirer.default.prompt) ? inquirer.default.prompt.bind(inquirer.default) : inquirer.prompt;
+
 /** Safe filename: non-empty, no path separators or reserved chars. */
 function toSafeFilename(value, fallback) {
     if (!value || typeof value !== 'string') return fallback;
@@ -14,16 +17,17 @@ function toSafeFilename(value, fallback) {
 }
 
 /**
- * Find wdio binary path relative to outputDir. Checks root node_modules then android-sample.
+ * Resolve wdio run command for the generated package.json script.
+ * Prefer local .bin/wdio so runs work offline; fallback to npx wdio when not found (e.g. app has no @wdio/cli yet).
  * @param {string} outDir - Absolute path to LT_Test (output dir)
- * @returns {string} Relative path to wdio binary
+ * @returns {string} Command string for the test script (e.g. "../node_modules/.bin/wdio" or "npx wdio")
  */
-function findWdioBinRelative(outDir) {
+function getWdioRunCommand(outDir) {
     const rootWdio = path.resolve(outDir, '../node_modules/.bin/wdio');
     const androidSampleWdio = path.resolve(outDir, '../android-sample/node_modules/.bin/wdio');
     if (fs.existsSync(rootWdio)) return '../node_modules/.bin/wdio';
     if (fs.existsSync(androidSampleWdio)) return '../android-sample/node_modules/.bin/wdio';
-    return '../node_modules/.bin/wdio';
+    return 'npx wdio';
 }
 
 /**
@@ -164,11 +168,12 @@ function buildCapabilitiesMulti(config) {
 }
 
 /**
- * Resolve LambdaTest service path: try package name first (npm install), then sibling (reference repo).
- * Reference repo layout: LT_Test/ (configs) and wdio-lambdatest-service/ as siblings.
+ * Resolve LambdaTest service: try wdio-lambdatest-service-sdk then wdio-lambdatest-service (npm), then sibling path.
+ * Package can be installed as wdio-lambdatest-service-sdk or wdio-lambdatest-service.
  */
 function getServicePathSnippet() {
     return `(function () {
+    try { return require.resolve('wdio-lambdatest-service-sdk'); } catch (e) {}
     try { return require.resolve('wdio-lambdatest-service'); } catch (e) {}
     return path.join(__dirname, '../wdio-lambdatest-service');
 })()`;
@@ -180,7 +185,11 @@ function getServicePathSnippet() {
  */
 function buildConfigTemplate(config, commonCaps, capabilities) {
     const servicePathExpr = getServicePathSnippet();
-    const safeSpecPath = config.specPath.replace(/\\/g, '/');
+    // Normalize: relative path only; no absolute paths or quotes (WDIO resolves from config dir)
+    let safeSpecPath = (config.specPath || '../specs/android-test.js').replace(/\\/g, '/').trim();
+    if (path.isAbsolute(safeSpecPath) || !safeSpecPath || /['"]/.test(safeSpecPath)) {
+        safeSpecPath = '../specs/android-test.js';
+    }
     const mergeSnippet = capabilities.length > 0
         ? `
 // Merge commonCapabilities into each capability
@@ -263,7 +272,7 @@ async function runGenerate() {
     console.log(chalk.dim('─'.repeat(40)));
     console.log();
 
-    const basicAnswers = await inquirer.default.prompt([
+    const basicAnswers = await prompt([
         {
             type: 'input',
             name: 'testName',
@@ -295,7 +304,7 @@ async function runGenerate() {
     console.log(chalk.dim('─'.repeat(40)));
     console.log();
 
-    const credAnswers = await inquirer.default.prompt([
+    const credAnswers = await prompt([
         {
             type: 'input',
             name: 'username',
@@ -320,19 +329,19 @@ async function runGenerate() {
     console.log();
     console.log(chalk.dim('─'.repeat(40)));
     console.log(chalk.cyan.bold(' ⚙️  Test Configuration'));
-    console.log(chalk.dim('─' .repeat(40)));
+    console.log(chalk.dim('─'.repeat(40)));
     console.log(chalk.dim('   (Use space to select, enter to confirm)'));
     console.log();
 
     // Step 1: Test Type (Multi-select)
-    const testTypeAnswer = await inquirer.default.prompt([
+    const testTypeAnswer = await prompt([
         {
             type: 'checkbox',
             name: 'testTypes',
             message: 'Test type(s):',
             choices: [
-                { name: '📱 Mobile Testing ', value: 'app', checked: true },
-                { name: '🌐 Browser Testing (Desktop)', value: 'browser' }
+                { name: ' 📱 Mobile Testing ', value: 'app', checked: true },
+                { name: ' 🌐 Browser Testing (Desktop)', value: 'browser' }
             ],
             validate: (input) => input.length > 0 || 'Please select at least one test type'
         }
@@ -348,14 +357,14 @@ async function runGenerate() {
         console.log();
 
         // Step 2: Device Type (Multi-select)
-        const deviceAnswer = await inquirer.default.prompt([
+        const deviceAnswer = await prompt([
             {
                 type: 'checkbox',
                 name: 'deviceTypes',
                 message: 'Device type(s):',
                 choices: [
-                    { name: '📲 Mobile Device', value: 'real', checked: true },
-                    { name: '💻 Website (Desktop)', value: 'virtual' }
+                    { name: ' 📲 Mobile Device (Real)', value: 'real', checked: true },
+                    { name: ' 💻 Mobile Device (Virtual)', value: 'virtual' }
                 ],
                 validate: (input) => input.length > 0 || 'Please select at least one device type'
             }
@@ -363,14 +372,14 @@ async function runGenerate() {
         config.deviceTypes = deviceAnswer.deviceTypes;
 
         // Step 3: Platform (Multi-select)
-        const platformAnswer = await inquirer.default.prompt([
+        const platformAnswer = await prompt([
             {
                 type: 'checkbox',
                 name: 'platforms',
                 message: 'Platform(s):',
                 choices: [
-                    { name: '🤖 Android', value: 'android', checked: true },
-                    { name: '🍎 iOS', value: 'ios' }
+                    { name: ' 🤖 Android', value: 'android', checked: true },
+                    { name: ' 🍎 iOS', value: 'ios' }
                 ],
                 validate: (input) => input.length > 0 || 'Please select at least one platform'
             }
@@ -378,14 +387,14 @@ async function runGenerate() {
         config.platforms = platformAnswer.platforms;
 
         // Step 4: What to test (Multi-select)
-        const testingTypeAnswer = await inquirer.default.prompt([
+        const testingTypeAnswer = await prompt([
             {
                 type: 'checkbox',
                 name: 'testingTypes',
                 message: 'What do you want to test?',
                 choices: [
-                    { name: '📦 Application (Native App)', value: 'app', checked: true },
-                    { name: '🌐 Website (Mobile Browser)', value: 'website' }
+                    { name: ' 📦 Application (Native App)', value: 'app', checked: true },
+                    { name: ' 🌐 Website (Mobile Browser)', value: 'website' }
                 ],
                 validate: (input) => input.length > 0 || 'Please select at least one testing type'
             }
@@ -405,7 +414,7 @@ async function runGenerate() {
                 const platformLabel = platform === 'ios' ? 'iOS' : 'Android';
                 const defaultAppId = getDefaultAppId(platform);
                 
-                const appIdAnswer = await inquirer.default.prompt([
+                const appIdAnswer = await prompt([
                     {
                         type: 'input',
                         name: 'appId',
@@ -426,7 +435,7 @@ async function runGenerate() {
     console.log(chalk.dim('─'.repeat(40)));
     console.log();
 
-    const parallelAnswer = await inquirer.default.prompt([
+    const parallelAnswer = await prompt([
         {
             type: 'number',
             name: 'parallel',
@@ -442,7 +451,7 @@ async function runGenerate() {
 
     // Spec file path (reference repo: LT_Test and specs/ are siblings, so ../specs/ from LT_Test)
     const defaultSpecPath = '../specs/android-test.js';
-    const specAnswer = await inquirer.default.prompt([
+    const specAnswer = await prompt([
         {
             type: 'input',
             name: 'specPath',
@@ -496,8 +505,8 @@ async function runGenerate() {
         pkg.scripts = {};
     }
 
-    const wdioBin = findWdioBinRelative(outputDir);
-    pkg.scripts[`test:${config.testName}`] = `${wdioBin} ${config.filename}`;
+    const wdioCmd = getWdioRunCommand(outputDir);
+    pkg.scripts[`test:${config.testName}`] = `${wdioCmd} ${config.filename}`;
     fs.writeFileSync(packageJsonPath, JSON.stringify(pkg, null, 2));
 
     // Success output

package/lib/cli/style.js

@@ -4,6 +4,82 @@
  */
 const chalk = require('chalk');
 
+// ASCII art logo (block style) for welcome banner – compact version
+const ASCII_LOGO = [
+    '██████████████               ██████████████',
+    '██████████████               ██████████████',
+    '██████████████               ██████████████',
+    '██████████████               ██████████████',
+    ' █████████████               ██████████████',
+    '  ████████████               ██████████████',
+    '    ██████████               ██████████████',
+    '      ████████               ██████████████',
+    '███████████████████████████████████████████',
+    '██████████████ ████████████████            ',
+    '██████████████  ███████████████            ',
+    '██████████████                             '
+];
+
+const BOX_WIDTH = 56;
+
+/**
+ * Build the welcome banner with box and ASCII art.
+ * @returns {string} Styled banner for CLI start/help
+ */
+function welcomeBanner() {
+    const c = chalk.cyan;
+    const bold = chalk.bold;
+    const dim = chalk.dim;
+    const w = BOX_WIDTH;
+    const top = c('╭') + c('─'.repeat(w - 2)) + c('╮');
+    const bottom = c('╰') + c('─'.repeat(w - 2)) + c('╯');
+    const side = c('│');
+    const pad = (s, len) => s + ' '.repeat(Math.max(0, len - s.length));
+    const center = (s, totalLen) => {
+        const n = Math.max(0, Math.floor((totalLen - s.length) / 2));
+        return ' '.repeat(n) + s + ' '.repeat(totalLen - n - s.length);
+    };
+    const title = 'Welcome to TestMU WDIO CLI';
+    const titleLine = side + ' ' + bold.white(center(title, w - 4)) + ' ' + side;
+    const tagline = 'WebdriverIO configuration tool for LambdaTest';
+    const tagLine = side + ' ' + dim(center(tagline, w - 4)) + ' ' + side;
+    const logoLines = ASCII_LOGO.map((line) => side + ' ' + c(pad(line.slice(0, w - 4), w - 4)) + ' ' + side);
+    const emptyLine = side + ' '.repeat(w - 2) + side;
+    return [
+        '',
+        top,
+        emptyLine,
+        titleLine,
+        emptyLine,
+        ...logoLines,
+        emptyLine,
+        tagLine,
+        emptyLine,
+        bottom,
+        ''
+    ].join('\n');
+}
+
+/**
+ * Build a compact box for CLI preview / tips (e.g. help footer).
+ * @param {string} title - Box title
+ * @param {string[]} lines - Content lines (plain text; chalk applied inside)
+ * @returns {string}
+ */
+function infoBox(title, lines) {
+    const cyan = chalk.cyan;
+    const dim = chalk.dim;
+    const bold = chalk.bold;
+    const contentWidth = Math.max(title.length, ...lines.map((l) => l.length), 40);
+    const w = contentWidth + 4;
+    const top = cyan('╭') + cyan('─'.repeat(w - 2)) + cyan('╮');
+    const bottom = cyan('╰') + cyan('─'.repeat(w - 2)) + cyan('╯');
+    const side = cyan('│');
+    const titleLine = side + ' ' + bold(title) + ' '.repeat(w - 3 - title.length) + side;
+    const content = lines.map((l) => side + ' ' + dim(l + ' '.repeat(contentWidth - l.length)) + ' ' + side);
+    return [top, titleLine, ...content, bottom].join('\n');
+}
+
 const style = {
     // Colors
     reset: chalk.reset,
@@ -51,7 +127,12 @@ const style = {
     },
 
     // Banner
-    banner: (text) => chalk.cyan.bold(`\n--- ${text} ---\n`)
+    banner: (text) => chalk.cyan.bold(`\n--- ${text} ---\n`),
+
+    // Welcome banner with ASCII art and box
+    welcomeBanner,
+    // Info box for tips / preview
+    infoBox
 };
 
 module.exports = style;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wdio-lambdatest-service-sdk",
-  "version": "5.1.5",
+  "version": "5.1.7",
   "description": "WebdriverIO service and CLI for LambdaTest Appium & browser automation",
   "main": "index.js",
   "repository": {
@@ -43,8 +43,8 @@
     "webdriverio": "^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0 || ^9.0.0"
   },
   "peerDependenciesMeta": {
-    "@wdio/cli": { "optional": false },
-    "webdriverio": { "optional": false }
+    "@wdio/cli": { "optional": true },
+    "webdriverio": { "optional": true }
   },
   "engines": {
     "node": ">=18.0.0",