Skip to content

Commit 5e37665

Browse files
JeeveshJ7JeeveshJ7
authored andcommitted
Project Name env variable
1 parent cb77dcd commit 5e37665

File tree

1 file changed

+54
-5
lines changed

1 file changed

+54
-5
lines changed

docs/smartui-cli-env-variables.md

Lines changed: 54 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,58 @@ Welcome to the world of simplified visual testing with the SmartUI SDK.
5353

5454
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:
5555

56+
## 1. Setting the Project Name
5657

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

58-
## 1. Setting the Baseline Branch
60+
<Tabs className="docs__val" groupId="language">
61+
<TabItem value="MacOS/Linux" label="MacOS/Linux" default>
62+
63+
```bash
64+
export LT_USERNAME="YOUR USERNAME"
65+
export LT_ACCESS_KEY="YOUR ACCESS KEY"
66+
export PROJECT_NAME="Required Project Name"
67+
```
68+
</TabItem>
69+
<TabItem value="Windows" label="Windows" default>
70+
71+
```bash
72+
set LT_USERNAME="YOUR USERNAME"
73+
set LT_ACCESS_KEY="YOUR ACCESS KEY"
74+
set PROJECT_NAME="Required Project Name"
75+
```
76+
</TabItem>
77+
</Tabs>
78+
79+
> 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.
85+
86+
<Tabs className="docs__val" groupId="language">
87+
<TabItem value="MacOS/Linux" label="MacOS/Linux" default>
88+
89+
```bash
90+
export PROJECT_TOKEN="123456#1234abcd-****-****-****-************"
91+
```
92+
93+
</TabItem>
94+
<TabItem value="Windows" label="Windows - CMD" default>
95+
96+
```bash
97+
set PROJECT_TOKEN="123456#1234abcd-****-****-****-************"
98+
```
99+
100+
</TabItem>
101+
</Tabs>
102+
103+
> Setting the project token env variable does not require any user level authentication.
104+
105+
<img loading="lazy" src={require('../assets/images/smart-visual-testing/project-token-primer.webp').default} alt="cmd" width="768" height="373" className="doc_img"/>
106+
107+
## 3. Setting the Baseline Branch
59108

60109
Set the baseline branch for `CLI` projects:
61110

@@ -74,7 +123,7 @@ set BASELINE_BRANCH="Required branch"
74123
</TabItem>
75124
</Tabs>
76125

77-
## 2. Setting the current branch
126+
## 4. Setting the current branch
78127

79128
Set the current branch for `CLI` projects:
80129

@@ -93,7 +142,7 @@ set CURRENT_BRANCH="Required branch"
93142
</TabItem>
94143
</Tabs>
95144

96-
## 3. Setting proxies
145+
## 5. Setting proxies
97146

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

@@ -135,7 +184,7 @@ set HTTPS_PROXY="Required branch"
135184

136185
> **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].
137186
138-
## 4. Enabling Debug mode
187+
## 6. Enabling Debug mode
139188

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

@@ -154,7 +203,7 @@ set LT_SDK_DEBUG=true
154203
</TabItem>
155204
</Tabs>
156205

157-
## 5. Ignoring captured cookies
206+
## 7. Ignoring captured cookies
158207

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

0 commit comments

Comments
 (0)