Skip to main content

SmartUI SDK Environment Variables


Welcome to the world of simplified visual testing with the SmartUI SDK.

This guide is designed to provide you with comprehensive information about the various environment variables options available within the SmartUI SDK. SmartUI retrieves additional details from the environment it is running in, like the branch name, baseline branch,proxies etc. You can modify certain aspects of SmartUI behavior by configuring these environment variables within your CI environment:

1. Setting the Project Name

Set the Project Name you want to add the current build run to by exporting these enviroment variables:

export LT_USERNAME="YOUR USERNAME"
export LT_ACCESS_KEY="YOUR ACCESS KEY"
export PROJECT_NAME="Required Project Name"

If you specify a project name that doesn't already exist, a new project will be created by the user whose authentication is added in the environment.

2: Set your Project Token

Setup your project token shown in the SmartUI app after creating your project.

export PROJECT_TOKEN="123456#1234abcd-****-****-****-************"

Setting the project token environment variable does not require any user level authentication.

cmd

3. Setting the Baseline Branch

Set the baseline branch for CLI projects:

export BASELINE_BRANCH="Required branch"

4. Setting the current branch

Set the current branch for CLI projects:

export CURRENT_BRANCH="Required branch"

5. Setting proxies

In case you are accessing your network using corporate proxies, set the proxies in the environment variables as follows

HTTP_PROXY:

export HTTP_PROXY="http://<username>:<password>@<domain.com>:<port>/"
<TabItem value="Windows-4" label='Windows - CMD'>

```bash
set HTTP_PROXY="http://<username>:<password>@<domain.com>:<port>"

HTTPS_PROXY:

export HTTPS_PROXY="https://<username>:<password>@<domain.com>:<port>"

NOTE : In most cases setting only HTTP_PROXY should be enough, but if you have different proxies for HTTP and HTTPS, you can set both.The format for proxy’s is http[s]://<username>:<password>@<domain.com>:<port>/ [username and password is optional].

6. Enabling Debug mode

To enable SmartUI CLI Debug mode, use the following environment variable.

export LT_SDK_DEBUG=true

7. Ignoring captured cookies

Set the following variable to true, to stop the use of cookies captured automatically. The default is set to false.

export SMARTUI_DO_NOT_USE_CAPTURED_COOKIES=true

8. Setting Server Address

For SDK integrations (non-Selenium), set the SmartUI server address:

export SMARTUI_SERVER_ADDRESS="http://localhost:8080"

9. Additional Environment Variables

The following environment variables are also available for advanced configuration:

VariableDescriptionDefault
FIGMA_TOKENFigma API token for Figma integration-
NO_PROXYComma-separated hosts to bypass proxy-
SMARTUI_HTTP_PROXYSmartUI-specific HTTP proxy-
SMARTUI_HTTPS_PROXYSmartUI-specific HTTPS proxy-
SMARTUI_API_PROXYAPI proxy configuration-
SMARTUI_CLIENT_API_URLOverride API URLhttps://api.lambdatest.com/visualui/1.0
SMARTUI_UPLOAD_URLOverride upload URLhttps://api.lambdatest.com
SMARTUI_GIT_INFO_FILEPATHCustom git info file path-
GITHUB_ACTIONSGitHub Actions environment flag-
SMARTUI_API_SKIP_CERTIFICATESSkip SSL certificate validationfalse
USE_REMOTE_DISCOVERYUse remote discovery modefalse
SMART_GITEnable Smart Git featurefalse
SHOW_RENDER_ERRORSShow render errorsfalse
SMARTUI_SSE_URLServer-sent events URLhttps://server-events.lambdatest.com
LT_SDK_SKIP_EXECUTION_LOGSSkip execution logsfalse
MAX_CONCURRENT_PROCESSINGMax concurrent processing threads0 (auto)
DO_NOT_USE_USER_AGENTDisable user agentfalse

Additional Resources

Test across 3000+ combinations of browsers, real devices & OS.

Book Demo

Help and Support

Related Articles