Skip to content

Commit 2891332

Browse files
authored
Merge pull request #1128 from Ishavyas9/main
Documentation for Project Name Environment Variable
2 parents fb05b95 + 56d3954 commit 2891332

File tree

1 file changed

+31
-6
lines changed

1 file changed

+31
-6
lines changed

docs/smartui-cli-env-variables.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ This guide is designed to provide you with comprehensive information about the v
5555

5656
## 1. Setting the Project Name
5757

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

6060
<Tabs className="docs__val" groupId="language">
6161
<TabItem value="MacOS/Linux" label="MacOS/Linux" default>
@@ -79,7 +79,32 @@ set PROJECT_NAME="Required Project Name"
7979
> 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.
8080
8181

82-
## 1. Setting the Baseline Branch
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" default>
95+
96+
```bash
97+
set PROJECT_TOKEN="123456#1234abcd-****-****-****-************"
98+
```
99+
100+
</TabItem>
101+
</Tabs>
102+
103+
> Setting the project token environment 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
83108

84109
Set the baseline branch for `CLI` projects:
85110

@@ -98,7 +123,7 @@ set BASELINE_BRANCH="Required branch"
98123
</TabItem>
99124
</Tabs>
100125

101-
## 2. Setting the current branch
126+
## 4. Setting the current branch
102127

103128
Set the current branch for `CLI` projects:
104129

@@ -117,7 +142,7 @@ set CURRENT_BRANCH="Required branch"
117142
</TabItem>
118143
</Tabs>
119144

120-
## 3. Setting proxies
145+
## 5. Setting proxies
121146

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

@@ -159,7 +184,7 @@ set HTTPS_PROXY="Required branch"
159184

160185
> **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].
161186
162-
## 4. Enabling Debug mode
187+
## 6. Enabling Debug mode
163188

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

@@ -178,7 +203,7 @@ set LT_SDK_DEBUG=true
178203
</TabItem>
179204
</Tabs>
180205

181-
## 5. Ignoring captured cookies
206+
## 7. Ignoring captured cookies
182207

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

0 commit comments

Comments
 (0)