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 Baseline Branch
Set the baseline branch for CLI
projects:
- MacOS/Linux
- Windows
export BASELINE_BRANCH="Required branch"
set BASELINE_BRANCH="Required branch"
2. Setting the current branch
Set the current branch for CLI
projects:
- MacOS/Linux
- Windows
export CURRENT_BRANCH="Required branch"
set CURRENT_BRANCH="Required branch"
3. Setting proxies
In case you are accessing your network using corporate proxies, set the proxies in the environment variables as follows
HTTP_PROXY:
- MacOS/Linux
- Windows
export HTTP_PROXY="Required branch"
set HTTP_PROXY="Required branch"
HTTPS_PROXY:
- MacOS/Linux
- Windows
export HTTPS_PROXY="Required branch"
set HTTPS_PROXY="Required branch"
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].
4. Enabling Debug mode
To enable SmartUI CLI Debug mode, use the following environment variable.
- MacOS/Linux
- Windows
export LT_SDK_DEBUG=true
set LT_SDK_DEBUG=true
5. Ignoring captured cookies
Set the following variable to true, to stop the use of cookies captured automatically. The default is set to false
.
- MacOS/Linux
- Windows
export SMARTUI_DO_NOT_USE_CAPTURED_COOKIES=true
set SMARTUI_DO_NOT_USE_CAPTURED_COOKIES=true