You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/smartui-cli-env-variables.md
+54-5Lines changed: 54 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,9 +53,58 @@ Welcome to the world of simplified visual testing with the SmartUI SDK.
53
53
54
54
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:
55
55
56
+
## 1. Setting the Project Name
56
57
58
+
Set the Project Name you want to add the current build run to by exporting these enviroment variables:
> 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.
80
+
81
+
82
+
## 2: Set your Project Token
83
+
84
+
Setup your project token show in the **SmartUI** app after, creating your project.
@@ -74,7 +123,7 @@ set BASELINE_BRANCH="Required branch"
74
123
</TabItem>
75
124
</Tabs>
76
125
77
-
## 2. Setting the current branch
126
+
## 4. Setting the current branch
78
127
79
128
Set the current branch for `CLI` projects:
80
129
@@ -93,7 +142,7 @@ set CURRENT_BRANCH="Required branch"
93
142
</TabItem>
94
143
</Tabs>
95
144
96
-
## 3. Setting proxies
145
+
## 5. Setting proxies
97
146
98
147
In case you are accessing your network using corporate proxies, set the proxies in the environment variables as follows
99
148
@@ -135,7 +184,7 @@ set HTTPS_PROXY="Required branch"
135
184
136
185
> **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].
137
186
138
-
## 4. Enabling Debug mode
187
+
## 6. Enabling Debug mode
139
188
140
189
To enable SmartUI CLI Debug mode, use the following environment variable.
141
190
@@ -154,7 +203,7 @@ set LT_SDK_DEBUG=true
154
203
</TabItem>
155
204
</Tabs>
156
205
157
-
## 5. Ignoring captured cookies
206
+
## 7. Ignoring captured cookies
158
207
159
208
Set the following variable to true, to stop the use of cookies captured automatically. The default is set to `false`.
0 commit comments