Skip to content

Commit 2c71655

Browse files
authored
Merge pull request LambdaTest#2135 from RushilK7/stage
katalon plugin doc
2 parents 4a81c3e + 2a4b761 commit 2c71655

File tree

1 file changed

+17
-46
lines changed

1 file changed

+17
-46
lines changed

docs/smartui-katalon-plugin.md

Lines changed: 17 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,6 @@ With this plugin, you can:
6060

6161
---
6262

63-
## Features
64-
65-
- **Visual Snapshots** — capture UI snapshots during test execution.
66-
- **Baseline Comparison** — automatically compare snapshots against stored baselines in SmartUI.
67-
- **Visual Regression Detection** — identify unintended UI changes with pixel-level accuracy.
68-
- **SmartUI Dashboard** — view diffs, approve/reject changes, and track regressions over time.
69-
70-
---
7163

7264
## Installation
7365

@@ -79,7 +71,7 @@ With this plugin, you can:
7971

8072
### Option 2: Manual Installation via JAR
8173

82-
1. Download the latest `katalon-studio-smartui-plugin.jar` from the [official release page](https://github.com/LambdaTest/katalon-studio-smartui-plugin/releases) (if available).
74+
1. Download the latest `katalon-studio-smartui-plugin.jar` from the [official release page](https://github.com/LambdaTest/katalon-studio-smartui-plugin/releases).
8375
2. In Katalon Studio, go to **Project > Settings > Plugins > Import Plugin**.
8476
3. Select the downloaded `.jar` file and click **Import**.
8577

@@ -99,42 +91,32 @@ With this plugin, you can:
9991
10092
---
10193

102-
### Step 2: Set Environment Variable
103-
104-
In your Katalon project, set the `PROJECT_TOKEN` environment variable:
94+
### Step 2: Start your Katalon Instance from terminal
10595

106-
#### Via Project Settings:
107-
1. Go to **Project > Settings > Execution > Profiles**.
108-
2. Under your active profile, add a new environment variable:
96+
Run the following command in the terminal to start the Katalon instance.
10997

110-
<Tabs className="docs__val" groupId="language">
111-
<TabItem value="MacOS/Linux" label="MacOS/Linux" default>
11298

11399
```bash
114-
export LT_USERNAME="YOUR_USERNAME"
115-
export LT_ACCESS_KEY="YOUR ACCESS KEY"
100+
/Applications/Katalon\ Studio\ Enterprise.app/Contents/MacOS/katalon
116101
```
117-
</TabItem>
118-
<TabItem value="Windows" label="Windows" default>
102+
---
119103

120-
```bash
121-
set LT_USERNAME="YOUR_USERNAME"
122-
set LT_ACCESS_KEY="YOUR ACCESS KEY"
123-
```
104+
### Step 3: Set Environment Variable
124105

125-
</TabItem>
126-
</Tabs>
106+
In your Katalon project, set the `PROJECT_TOKEN` environment variable:
127107

128-
#### Or via Script (Global Variable):
129-
You can also set it dynamically in your test script:
108+
#### Via Project Settings:
109+
1. Go to **Project > Settings > Plugins > SmartUI Integration**.
110+
2. Here you may set your project token
130111

131-
```groovy
132-
System.setProperty("PROJECT_TOKEN", "123456#1234abcd-****-****-****-************")
112+
113+
```bash
114+
PROJECT_TOKEN = "project_token..."
133115
```
134116

135117
---
136118

137-
### Step 3: Configure SmartUI in Your Test Case
119+
### Step 4: Configure SmartUI in Your Test Case
138120

139121
Use the provided custom keywords to start, capture, and stop SmartUI sessions.
140122

@@ -162,7 +144,7 @@ WebUI.closeBrowser()
162144

163145
---
164146

165-
### Step 4: Advanced Configuration (Optional)
147+
### Step 5: Advanced Configuration (Optional)
166148

167149
You can pass additional configuration via a JSON file or inline parameters.
168150

@@ -188,8 +170,8 @@ Then use it in your test:
188170
CustomKeywords.'com.katalon.plugin.keyword.smartui.SmartKeywords.startServer'('Build v1.0', 'config.json', '')
189171
```
190172

191-
> 💡 Use `ignoreBoxes` to exclude dynamic elements (ads, timestamps) from comparison.
192-
> 💡 Use `selectBoxes` to compare only specific regions (e.g., main content area).
173+
> Use `ignoreBoxes` to exclude dynamic elements (ads, timestamps) from comparison.
174+
> Use `selectBoxes` to compare only specific regions (e.g., main content area).
193175
194176
---
195177

@@ -221,16 +203,6 @@ CustomKeywords.'com.katalon.plugin.keyword.smartui.SmartKeywords.startServer'('B
221203

222204
---
223205

224-
## 🌐 Learn More
225-
226-
For detailed API documentation and advanced features, visit:
227-
228-
- [SmartUI Documentation](https://www.lambdatest.com/support/docs/smart-visual-regression-testing/)
229-
- [Katalon Studio Docs](https://docs.katalon.com/)
230-
- [Plugin GitHub Repository](https://github.com/LambdaTest/katalon-studio-smartui-plugin)
231-
232-
---
233-
234206
<nav aria-label="breadcrumbs">
235207
<ul className="breadcrumbs">
236208
<li className="breadcrumbs__item">
@@ -248,4 +220,3 @@ For detailed API documentation and advanced features, visit:
248220
</li>
249221
</ul>
250222
</nav>
251-
```

0 commit comments

Comments
 (0)