Skip to content

docs: document --config for SmartUI CLI exec #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RushilK7 merged 1 commit into from
Mar 27, 2026
Merged

docs: document --config for SmartUI CLI exec #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Welcome to the SmartUI SDK sample for Selenium Java with TestNG. This repository demonstrates how to integrate SmartUI visual regression testing with Selenium Java using TestNG framework.

## Get your SmartUI project and token

If you are new to SmartUI, follow [Running Your First Project on SmartUI](https://www.lambdatest.com/support/docs/smartui-running-your-first-project/) to create a project and obtain your **project token** and `smartui-web.json` configuration.

## Repository Structure

```
Expand Down Expand Up @@ -98,16 +102,18 @@ SmartUISnapshot.smartuiSnapshot(driver, "screenshot");

## 4. Execution and Commands

Pass `--config smartui-web.json` to the SmartUI CLI so it uses this repository’s config (project id, token path, and build naming). Place it **before** `exec` (it is a global CLI option).

### Local Execution

```bash
npx smartui exec -- mvn test -D suite=sdk-local.xml
npx smartui --config smartui-web.json exec -- mvn test -D suite=sdk-local.xml
```

### Cloud Execution

```bash
npx smartui exec -- mvn test -D suite=sdk-cloud.xml
npx smartui --config smartui-web.json exec -- mvn test -D suite=sdk-cloud.xml
```

## Test Files
Expand Down Expand Up @@ -258,7 +264,7 @@ jobs:
LT_USERNAME: ${{ secrets.LT_USERNAME }}
LT_ACCESS_KEY: ${{ secrets.LT_ACCESS_KEY }}
run: |
npx smartui exec -- mvn test -D suite=sdk-cloud.xml
npx smartui --config smartui-web.json exec -- mvn test -D suite=sdk-cloud.xml
```

### Jenkins Pipeline Example
Expand Down Expand Up @@ -288,7 +294,7 @@ pipeline {
stage('Visual Tests') {
steps {
sh 'npm install -g @lambdatest/smartui-cli'
sh 'npx smartui exec -- mvn test -D suite=sdk-cloud.xml'
sh 'npx smartui --config smartui-web.json exec -- mvn test -D suite=sdk-cloud.xml'
}
}
}
Expand Down
Loading