### Example Workflow for SmartUI Tests

Source: https://www.lambdatest.com/support/docs/smartui-sdk-fetch-results

This example demonstrates a typical workflow for running SmartUI tests, fetching results, uploading to the SmartUI Reporter, and viewing/exporting the results. Ensure you have the SmartUI CLI installed and configured.

```bash
# 1. Run SmartUI tests and fetch results  
npx smartui capture urlTest.json --config config.json --fetch-results results.json  
  
# 2. Upload results.json to SmartUI Reporter  
# Visit https://smartui-reporter.netlify.app/ and upload the file  
  
# 3. View results in tabular format with statistics  
  
# 4. Export to PDF or CSV for sharing  
```

--------------------------------

### Clone Sample Project

Source: https://www.lambdatest.com/support/docs/nunit-with-selenium-running-nunit-automation-scripts-on-lambdatest-selenium-grid

Clone the NUnit Selenium sample repository to get started.

```bash
git clone https://github.com/LambdaTest/CSharp-NUnit-Selenium
cd CSharp-NUnit-Selenium
```

--------------------------------

### Setup HyperExecute CLI on Alpine Linux

Source: https://www.lambdatest.com/support/docs/hyperexecute-cli-run-tests-on-hyperexecute-grid

Install necessary dependencies and clone the sample repository to run HyperExecute CLI on minimal Alpine Linux environments. Ensure the `hyperexecute` binary is executable.

```bash
apk add libc6-compat git bash
git clone https://github.com/LambdaTest/behave-selenium-hyperexecute-sample.git
cd behave-selenium-hyperexecute-sample/
wget https://downloads.lambdatest.com/hyperexecute/linux/hyperexecute
chmod +x hyperexecute
./hyperexecute --user <lt_user> --key <lt_access_key> --config yaml/win/behave_hyperexecute_autosplit_sample.yaml
```

--------------------------------

### Minimal SmartUI Test Case in Katalon

Source: https://www.lambdatest.com/support/docs/smartui-katalon-plugin

This minimal example demonstrates how to start the SmartUI server, open a browser, navigate to a URL, capture a snapshot, stop the server, and close the browser using Katalon Studio's custom keywords.

```groovy
// Start SmartUI Server  
// Replace 'buildName' with your desired build name (optional)  
CustomKeywords.'com.katalon.plugin.keyword.smartui.SmartKeywords.startServer'('My Katalon Build', '', '')  
  
// Open Browser  
WebUI.openBrowser('')  
WebUI.navigateToUrl('https://lambdatest.com')  
  
// Capture Snapshot with SmartUI  
// The string parameter is the snapshot name (will appear in SmartUI Dashboard)  
CustomKeywords.'com.katalon.plugin.keyword.smartui.SmartKeywords.takeSnapshot'('Homepage Snapshot')  
  
// Stop SmartUI Server  
CustomKeywords.'com.katalon.plugin.keyword.smartui.SmartKeywords.stopServer'()  
  
// Close Browser  
WebUI.closeBrowser()  

```

--------------------------------

### SmartUI CLI SDK Test Execution Setup

Source: https://www.lambdatest.com/support/docs/smartui-cli-complete-reference

Set up and run tests using the SmartUI CLI's SDK execution mode. Includes starting and stopping the server and setting the server address.

```bash
# 1. Set project token  
export PROJECT_TOKEN="123456#token"  

# 2. Start server  
npx smartui exec:start  

# 3. Set server address (for non-Selenium)  
export SMARTUI_SERVER_ADDRESS='http://localhost:49152'  

# 4. Run tests  
npm test  

# 5. Stop server  
npx smartui exec:stop
```

--------------------------------

### Clone Sample Project and Setup Environment

Source: https://www.lambdatest.com/support/docs/pytest-with-selenium-running-pytest-automation-script-on-testmu-selenium-grid

Clone the provided GitHub repository and navigate into the project directory.

```bash
git clone https://github.com/LambdaTest/pytest-selenium-sample
cd pytest-selenium-sample
```

--------------------------------

### Clone Sample Repository for SmartUI SDK

Source: https://www.lambdatest.com/support/docs/smartui-cypress-sdk

Clone the sample repository to get started with Cypress tests using the SmartUI SDK. This provides a base for your visual testing setup.

```bash
git clone https://github.com/LambdaTest/smartui-cypress-sdk-sample
cd smartui-cypress-sdk-sample
```

--------------------------------

### Clone Sample Project and Setup Environment

Source: https://www.lambdatest.com/support/docs/automation-testing-selenium-with-lettuce

Clone the sample Lettuce project repository and navigate into the project directory.

```bash
git clone https://github.com/LambdaTest/sample-lettuce  
cd sample-lettuce  
```

--------------------------------

### Manual Tunnel Setup Example

Source: https://www.lambdatest.com/support/docs/smartui-sdk-tunnel

An example of manual tunnel configuration for SmartUI SDK, specifying the tunnel name and optional user/key overrides. This setup is useful when environment variables are not provided.

```json
{
  "web": {
    "browsers": ["chrome", "firefox"],
    "viewports": [[1920, 1080], [1366, 768]]
  },
  "tunnel": {
    "type": "manual",
    "tunnelName": "my-tunnel",
    "user": "<lambdatest-user>",  // Optional: Overrides LT_USERNAME if present in env
    "key": "<lambdatest-accesskey>",  // Optional: Overrides LT_ACCESS_KEY if present in env
  }
}

```

--------------------------------

### Create and Configure .env File

Source: https://www.lambdatest.com/support/docs/laravel-dusk-with-selenium-running-laravel-dusk-automation-scripts-on-testmu-selenium-grid

Copy the example .env file and update it with your TestMu AI credentials.

```bash
cp .env.example .env  
```

```bash
LT_USERNAME="<Your_Username>"  
LT_ACCESS_KEY="<Your_Access_Key>"  
```

--------------------------------

### Basic Automatic Tunnel Setup Example

Source: https://www.lambdatest.com/support/docs/smartui-sdk-tunnel

A basic example of automatic tunnel configuration within a SmartUI SDK setup, including browser and viewport settings. User and key can be provided if environment variables are not set.

```json
{
  "web": {
    "browsers": ["chrome", "firefox"],
    "viewports": [[1920, 1080], [1366, 768]]
  },
  "tunnel": {
    "type": "auto"
      //Add user and key in case LT_USERNAME and LT_ACCESSKEY not provided in env variables

  }
}

```

--------------------------------

### Clone Sample Project and Navigate

Source: https://www.lambdatest.com/support/docs/pytest-with-selenium-running-pytest-automation-script-on-lambdatest-selenium-grid

Clone the provided sample project repository and navigate into its directory.

```bash
git clone https://github.com/LambdaTest/pytest-selenium-sample  
cd pytest-selenium-sample  
```

--------------------------------

### Install Dependencies in HyperExecute

Source: https://www.lambdatest.com/support/docs/hyperexecute-yaml-creation-for-playwright

Prevent 'Cannot find module' errors by ensuring all project dependencies are installed. This example shows how to run `npm install` in the `pre` step of the HyperExecute YAML configuration.

```yaml
pre:  
  - npm install  
```

--------------------------------

### Start HyperExecute Info API Server

Source: https://www.lambdatest.com/support/docs/hyperexecute-cli-run-tests-on-hyperexecute-grid

Use the `serve` flag to start a server that provides HyperExecute info APIs. Requires user name and access key.

```bash
hyperexecute --user USER_NAME --key ACCESS_KEY serve  
```

--------------------------------

### Install Additional Frameworks with Runtime

Source: https://www.lambdatest.com/support/docs/deep-dive-into-hyperexecute-yaml

Install additional frameworks like Gauge or Gradle alongside the primary language runtime. This example installs Java 11 with Gauge and Gradle addons.

```yaml
runtime:  
  - language: java  
    version: 11  
    addons:  
      - name: "gauge"  
        version: "1.4.0"  
      - name: "gradle"  
        version : "7.0"  

```

--------------------------------

### Match any version starting with a string

Source: https://www.lambdatest.com/support/docs/regular-expression-appium

Use '.*' to match any platform version that begins with the specified string. For example, to match versions starting with '13' or '14'.

```regex
"13.*"
```

```regex
"14.*"
```

--------------------------------

### Example Browser Configuration (Safari)

Source: https://www.lambdatest.com/support/docs/vividus-integration

Example of setting the browser to Safari in the configuration.properties file.

```properties
configuration.profiles=lambdatest/web,web/desktop/safari
```

--------------------------------

### Clone Sample Project

Source: https://www.lambdatest.com/support/docs/specflow-with-selenium-running-specflow-automation-scripts-on-testmu-selenium-grid

Clone the SpecFlow-Selenium-Sample repository to get started.

```bash
git clone https://github.com/LambdaTest/SpecFlow-Selenium-Sample
cd SpecFlow-Selenium-Sample
```

--------------------------------

### Example Build Naming Convention

Source: https://www.lambdatest.com/support/docs/smartui-pdf-cli-upload

Demonstrates a recommended build naming convention that includes the release version and the current date for better tracking and organization.

```bash
smartui upload-pdf ./pdfs/ --buildName Release-v1.0-$(date +%Y%m%d)"
```

--------------------------------

### Start Bamboo Server

Source: https://www.lambdatest.com/support/docs/bamboo-integration-with-hyperexecute

Navigate to the Bamboo installation directory and start the Bamboo server using the provided script. Access the Bamboo GUI via localhost:8085.

```bash
cd ROOT_FOLDER  

./bin/start-bamboo.sh  
```

--------------------------------

### Start Server

Source: https://www.lambdatest.com/support/docs/smartui-cli-complete-reference

Start the SmartUI snapshot server.

```APIDOC
## Start Server

Start the SmartUI snapshot server.

### Syntax
```
smartui exec:start [options]
```

### Options
| Option | Short | Description | Default |
|---|---|---|---|
| `--port <number>` | `-P` | Port number for server | `49152` |
| `--fetch-results [filename]` |  | Fetch results and save to JSON | `results.json` |
| `--buildName <string>` |  | Custom build name | Random |

### Examples
```bash
# Start on default port
smartui exec:start

# Start on custom port
smartui exec:start -P 5000

# With build name
smartui exec:start --buildName "Server-Build"
```

### Usage Workflow
1. Start server:
```bash
smartui exec:start
```

2. Set server address (for non-Selenium SDKs):
```bash
export SMARTUI_SERVER_ADDRESS='http://localhost:49152'
```

3. Run tests:
```bash
npm test
```

4. Stop server:
```bash
smartui exec:stop
```
```

--------------------------------

### Example GET Request

Source: https://www.lambdatest.com/support/docs/kaneai-kb-api-testing-and-network-assertions

Use this curl command to make a GET request to an API endpoint. Ensure you replace placeholder values with your actual API details and authentication tokens.

```curl
curl -X GET "https://api.example.com/users/123" \
  -H "Authorization: Bearer {{secret.api_token}}" \
  -H "Content-Type: application/json"  

```

--------------------------------

### Example Repository Structure

Source: https://www.lambdatest.com/support/docs/github-app-integration

Illustrates the recommended repository structure including the .lambdatest configuration directory and agent.md file.

```text
your-repo/  
├── .lambdatest/  
│   └── config.yaml          # LambdaTest configuration  
    └── agent.md             # Optional file for custom instructions to enhance responses  
├── src/                     # Your application source code  
├── README.md                # Detailed project documentation (used by AI)  
└── ... other project files  

```

--------------------------------

### Clone Sample Project and Setup Environment

Source: https://www.lambdatest.com/support/docs/robot-with-selenium-running-robot-automation-scripts-on-testmu-selenium-grid

Clone the Robot Framework Selenium sample project and set up the virtual environment.

```bash
git clone https://github.com/LambdaTest/Robot-Selenium-Sample  
cd Robot-Selenium-Sample  
```

```bash
virtualenv venv  
source venv/bin/activate  
```

```bash
pip install -r requirements.txt  
```

--------------------------------

### Clone Sample Project

Source: https://www.lambdatest.com/support/docs/specflow-with-selenium-running-specflow-automation-scripts-on-lambdatest-selenium-grid

Clone the SpecFlow Selenium sample repository to get started.

```bash
git clone https://github.com/LambdaTest/SpecFlow-Selenium-Sample  
cd SpecFlow-Selenium-Sample  
```

--------------------------------

### Clone Sample Project and Install Dependencies

Source: https://www.lambdatest.com/support/docs/testunit-with-selenium-running-testunit-automation-scripts-on-testmu-selenium-grid

Clone the provided sample repository and install the necessary project dependencies using Bundler.

```bash
git clone https://github.com/LambdaTest-sample-test-frameworks/Ruby-UnitTest-Selenium.git
cd Ruby-UnitTest-Selenium
```

```bash
bundle install
```

--------------------------------

### Clone Sample Project

Source: https://www.lambdatest.com/support/docs/mstest-with-selenium-running-mstest-automation-scripts-on-lambdatest-selenium-grid

Clone the MSTest Selenium sample repository to get started.

```bash
git clone https://github.com/LambdaTest/MSTest-Selenium-Sample
cd MSTest-Selenium-Sample
```

--------------------------------

### Clone Repository and Set Up Python Environment

Source: https://www.lambdatest.com/support/docs/localstack-integration-with-testmu

Clone the sample project repository and set up a Python virtual environment with necessary dependencies. Ensure you activate the virtual environment before proceeding.

```bash
git clone   
git@github.com:localstack-samples/sample-serverless-image-resizer-s3-lambda.git  
cd sample-serverless-image-resizer-s3-lambda  
python -m venv .venv  
source .venv/bin/activate  
pip install -r requirements-dev.txt  
```

--------------------------------

### Clone Sample Project and Set Up Environment

Source: https://www.lambdatest.com/support/docs/behave-with-selenium-running-behave-automation-scripts-on-lambdatest-selenium-grid

Clone the Python-Behave-Selenium repository and set up a virtual environment. Activate the environment and install required packages.

```bash
git clone https://github.com/LambdaTest/Python-Behave-Selenium  
cd Python-Behave-Selenium  
```

```bash
virtualenv venv  
source venv/bin/activate  
```

```bash
pip install -r requirements.txt  
```

--------------------------------

### Clone Playwright Sample Repository

Source: https://www.lambdatest.com/support/docs/typescript-with-playwright

Clone the sample repository for Playwright TypeScript from GitHub to get started.

```bash
git clone https://github.com/LambdaTest/playwright-sample.git  
cd playwright-sample  
cd playwright-test-ts  
```

--------------------------------

### Clone Sample Project and Setup Environment

Source: https://www.lambdatest.com/support/docs/running-unit-testing-in-python-on-lambdatest-selenium-grid

Clone the Python-UnitTest-Selenium repository and navigate into the project directory.

```bash
git clone https://github.com/LambdaTest/Python-UnitTest-Selenium  
cd Python-UnitTest-Selenium  
```

--------------------------------

### Clone Playwright Sample Repository

Source: https://www.lambdatest.com/support/docs/javascript-with-playwright

Clone the sample repository to get started with Playwright JavaScript tests.

```bash
git clone https://github.com/LambdaTest/playwright-sample.git  
cd playwright-sample  
cd playwright-test-js  
```

--------------------------------

### Clone Sample Project and Set Up Environment

Source: https://www.lambdatest.com/support/docs/behave-with-selenium-running-behave-automation-scripts-on-testmu-selenium-grid

Clone the Python-Behave-Selenium repository and navigate into the project directory.

```bash
git clone https://github.com/LambdaTest/Python-Behave-Selenium  
cd Python-Behave-Selenium  
```

--------------------------------

### Clone fastlane Sample Repository

Source: https://www.lambdatest.com/support/docs/fastlane-with-testmu

Clone the provided GitHub repository to get started with the fastlane sample.

```bash
git clone https://github.com/LambdaTest/fastlane-android-sample  

```

--------------------------------

### Install All Playwright Dependencies and Browsers

Source: https://www.lambdatest.com/support/docs/hyperexecute-yaml-creation-for-playwright

Ensure successful test execution on HyperExecute by installing all necessary Playwright dependencies, including browsers. This resolves issues where tests fail to start due to missing browser binaries.

```yaml
pre:
  - npx playwright install --with-deps
```

--------------------------------

### SDK Console Output Example

Source: https://www.lambdatest.com/support/docs/browser-cloud-debugging

The SDK logs connection steps and actions to standard output during session setup.

```text
Adapter: Connecting to session session_123_abc via Puppeteer...
Adapter: Set stealth user-agent: Mozilla/5.0 (Windows NT 10.0...
Adapter: Set stealth viewport: 1907x1063
Adapter: Humanized interactions enabled
Adapter: Loading profile my-app-login
```

--------------------------------

### Install K6 on Windows

Source: https://www.lambdatest.com/support/docs/smartui-k6-setup

Install the K6 performance testing tool on Windows using winget.

```bash
winget install k6
```

--------------------------------

### Clone Sample Repository

Source: https://www.lambdatest.com/support/docs/smartui-playwright-sdk

Clone the sample repository to get started with LambdaTest automation tests using SmartUI.

```bash
git clone https://github.com/LambdaTest/smartui-playwright-sample
cd smartui-playwright-sample/sdk
```

--------------------------------

### Install Project Configurations

Source: https://www.lambdatest.com/support/docs/puppeteer-testing-with-pytest-pyppeteer

Install project configurations using Poetry.

```bash
poetry install  
```

--------------------------------

### Clone Sample Playwright Repository

Source: https://www.lambdatest.com/support/docs/playwright-visual-regression

Clone the provided GitHub repository to get started with a sample Playwright project.

```bash
git clone https://github.com/LambdaTest/playwright-sample  

```

--------------------------------

### Start SmartUI Server with Config File

Source: https://www.lambdatest.com/support/docs/smartui-katalon-plugin

This code snippet shows how to start the SmartUI server in Katalon Studio, passing a configuration file ('config.json') and a build name. This allows for more detailed control over the screenshot capture process.

```groovy
CustomKeywords.'com.katalon.plugin.keyword.smartui.SmartKeywords.startServer'('Build v1.0', 'config.json', '')  

```

--------------------------------

### Run Cypress Tests

Source: https://www.lambdatest.com/support/docs/cypress-cli-commands

Initiates the test build execution. Refer to the guide for detailed examples of Cypress flags.

```bash
lambdatest-cypress run  
```

--------------------------------

### Manual Tunnel Setup

Source: https://www.lambdatest.com/support/docs/browser-cloud-tunnel

For more control, you can manually start and stop the tunnel. This is useful for reusing a tunnel across multiple sessions.

```APIDOC
## Manual Tunnel Setup

### Description
Manually start the tunnel using `client.tunnel.start()` and stop it using `client.tunnel.stop()`. This allows for reusing a tunnel across multiple sessions.

### Methods
- `client.tunnel.start(config)`
- `client.tunnel.stop()`
- `client.tunnel.getStatus()`

### Parameters for `client.tunnel.start(config)`
#### Request Body (config object)
- **user** (string) - Required - TestMu AI username.
- **key** (string) - Required - TestMu AI access key.
- **tunnelName** (string) - Optional - Named tunnel for identification.
- **proxyHost** (string) - Optional - Corporate proxy host.
- **proxyPort** (string) - Optional - Corporate proxy port.
- **proxyUser** (string) - Optional - Proxy authentication user.
- **proxyPass** (string) - Optional - Proxy authentication password.
- **logFile** (string) - Optional - Log file path.

### Request Example (Starting Tunnel)
```javascript
await client.tunnel.start({
    user: process.env.LT_USERNAME!,
    key: process.env.LT_ACCESS_KEY!,
    tunnelName: 'my-tunnel',
});
```

### Response (client.tunnel.getStatus())
#### Success Response
- **status** (boolean) - Returns `true` if the tunnel is running, `false` otherwise.

### Usage Example
```javascript
// Start the tunnel
await client.tunnel.start({
    user: process.env.LT_USERNAME!,
    key: process.env.LT_ACCESS_KEY!,
    tunnelName: 'my-tunnel',
});

console.log('Tunnel running:', client.tunnel.getStatus()); // true

// Create sessions that use it
const session = await client.sessions.create({
    adapter: 'puppeteer',
    tunnel: true,
    tunnelName: 'my-tunnel',
    lambdatestOptions: { ... }
});

// ... agent work ...

// Stop when done
await client.tunnel.stop();
```
```

--------------------------------

### Install SmartUI CLI and Set Project Token

Source: https://www.lambdatest.com/support/docs/smartui-cli-complete-reference

Install the SmartUI CLI globally and set the project token environment variable, prerequisites for basic static URL capture.

```bash
# 1. Install CLI  
npm install -g @lambdatest/smartui-cli  

# 2. Set project token  
export PROJECT_TOKEN="123456#token"
```

--------------------------------

### Start GoCD Server

Source: https://www.lambdatest.com/support/docs/gocd-integration-with-hyperexecute

Run this command in the gocd/bin folder to start the GoCD server.

```bash
./bin/go-server start
```

--------------------------------

### Clone Sample GitHub Repository

Source: https://www.lambdatest.com/support/docs/smartui-cli-figma-web

Clone the sample repository to get a working example of SmartUI Figma integration for web.

```bash
git clone https://github.com/LambdaTest/smartui-figma-web-cli-sample  
```

--------------------------------

### Create SmartUI Config and Capture Screenshots

Source: https://www.lambdatest.com/support/docs/smartui-cli-complete-reference

Create a SmartUI configuration file and capture screenshots using the CLI. Assumes project token is set and URLs file exists.

```bash
# 3. Create config  
npx smartui config:create .smartui.json  

# 4. Create URLs file (urls.json)  
# 5. Capture screenshots  
npx smartui capture urls.json --config .smartui.json
```

--------------------------------

### Run Local Pre-Execution Commands

Source: https://www.lambdatest.com/support/docs/deep-dive-into-hyperexecute-yaml

Execute local commands before the job starts, such as installing dependencies. This is an alternative to the deprecated `beforeAll` flag.

```yaml
beforeAll:
  location: local/remote
  type: discovery/update_payload
  local:
    commands:
pip install -r requirements.txt

```

--------------------------------

### Define Dev Dependencies in package.json

Source: https://www.lambdatest.com/support/docs/run-settings

Example of `devDependencies` section in `package.json` that TestMu AI can detect for installing dependencies before running tests.

```json
"devDependencies": {
    "cypress": "9.2.1",
    "eslint": "7.0.0",
    "eslint-plugin-json-format": "2.0.1",
    "eslint-plugin-mocha": "5.3.0",
  },

```

--------------------------------

### Install Project Dependencies

Source: https://www.lambdatest.com/support/docs/ruby-with-capybara-running-automation-scripts-on-lambdatest-selenium-grid

Install all necessary project dependencies using the 'bundle install' command.

```bash
bundle install
```

--------------------------------

### Clone Sample Project and Install Dependencies

Source: https://www.lambdatest.com/support/docs/ruby-with-selenium-running-ruby-automation-scripts-on-testmu-selenium-grid

Clone the provided Ruby Selenium sample project repository and navigate into the project directory. Then, install the necessary selenium-webdriver gem.

```bash
git clone https://github.com/LambdaTest/ruby-selenium-sample.git
cd ruby-selenium-sample
```

```bash
sudo gem install selenium-webdriver
```

--------------------------------

### Trigger WebdriverIO Tests

Source: https://www.lambdatest.com/support/docs/selenium-bidi-integration

Execute this command in your terminal to start your tests on the TestMu AI platform using the configured WebdriverIO setup.

```bash
npm run wdio  

```

--------------------------------

### Clone LambdaTest Cypress Cloud Repo

Source: https://www.lambdatest.com/support/docs/cypress-testing-using-webkit

Clone the sample Cypress Cloud repository to get started with Cypress testing on LambdaTest.

```bash
git clone https://github.com/LambdaTest/Cypress-Cloud.git
cd Cypress-Cloud
```

--------------------------------

### Clone Sample Project

Source: https://www.lambdatest.com/support/docs/smartui-pdf-java-sdk

Clone the sample project repository to begin. This provides a base for your integration.

```bash
git clone https://github.com/LambdaTest/junit-selenium-sample.git
cd junit-selenium-sample
```

--------------------------------

### Example Build Name with Date

Source: https://www.lambdatest.com/support/docs/smartui-pdf-api-upload

An example of a dynamic build name that includes the current date for version tracking.

```bash
buildName="PDF-Comparison-v1.0-$(date +%Y%m%d)"
```

--------------------------------

### Clone Playwright C# Sample Repository

Source: https://www.lambdatest.com/support/docs/csharp-with-playwright

Clone the sample repository for Playwright C# from GitHub to get started with the demo project.

```bash
git clone https://github.com/LambdaTest/playwright-sample.git  
cd playwright-sample  
cd playwright-csharp  
```

--------------------------------

### Install SmartUI Storybook CLI and Capture Stories

Source: https://www.lambdatest.com/support/docs/smartui-cli-complete-reference

Install the SmartUI Storybook CLI, set the project token, and capture stories from a running Storybook instance.

```bash
# 1. Install Storybook CLI  
npm install -g @lambdatest/smartui-storybook  

# 2. Set project token  
export PROJECT_TOKEN="123456#token"  

# 3. Start Storybook  
npm run storybook  

# 4. Capture stories  
smartui storybook http://localhost:6006 --config .smartui.json
```

--------------------------------

### Example of 'Starts With' Operator in KaneAI

Source: https://www.lambdatest.com/support/docs/kaneai-conditional-logic

The 'starts_with' operator checks if the left operand begins with the specified right operand. This is useful for prefix matching.

```plaintext
starts_with | Left operand starts with the right operand
```

--------------------------------

### Set Environment Variables

Source: https://www.lambdatest.com/support/docs/deep-dive-into-hyperexecute-yaml

Define environment variables to be used within your test environment or for installing dependencies. This example sets USERNAME and PLATFORM.

```yaml
env:  
  USERNAME: abc  
  PLATFORM: windows  

```

--------------------------------

### SmartUI CLI Help Information

Source: https://www.lambdatest.com/support/docs/smartui-cli-upload

Display all available help information and options for the SmartUI CLI.

```bash
smartui upload --help
```

--------------------------------

### Example Workflow: Running SmartUI Storybook CLI

Source: https://www.lambdatest.com/support/docs/smartui-git-branching-strategy

An example demonstrating the workflow of committing changes and then executing the SmartUI Storybook CLI command to run visual regression tests.

```bash
$ git branch
* master
```

```bash
$ git commit -m "Second Build Changes"
```

```bash
$ smartui storybook http://localhost:6006 --config .smartui.json
```