Skip to content

Commit 28febed

Browse files
JeeveshJ7JeeveshJ7
authored andcommitted
Added Readme
1 parent c7b8e9c commit 28febed

File tree

1 file changed

+48
-30
lines changed

1 file changed

+48
-30
lines changed

packages/cli/README.md

Lines changed: 48 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,65 @@
1-
# SmartUI CLI
2-
[![SmartUI-Testing](https://smartui.lambdatest.com/static/media/LTBadge.64a05e73.svg)](https://smartui.lambdatest.com)
1+
# SmartUI-CLI
32

4-
The SmartUI CLI is used to create configs, take screenshots and upload to [SmartUI Dashboard](https://smartui.lambdatest.com/) via
5-
the command line.
3+
<img height="400" src="https://user-images.githubusercontent.com/126776938/232535511-8d51cf1b-1a33-48fc-825c-b13e7a9ec388.png">
4+
5+
<p align="center">
6+
<a href="https://www.lambdatest.com/blog/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Blog</a>
7+
&nbsp; &#8901; &nbsp;
8+
<a href="https://www.lambdatest.com/support/docs/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Docs</a>
9+
&nbsp; &#8901; &nbsp;
10+
<a href="https://www.lambdatest.com/learning-hub/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Learning Hub</a>
11+
&nbsp; &#8901; &nbsp;
12+
<a href="https://www.lambdatest.com/newsletter/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Newsletter</a>
13+
&nbsp; &#8901; &nbsp;
14+
<a href="https://www.lambdatest.com/certifications/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Certifications</a>
15+
&nbsp; &#8901; &nbsp;
16+
<a href="https://www.youtube.com/c/LambdaTest" target="_bank">YouTube</a>
17+
</p>
18+
&emsp;
19+
&emsp;
20+
&emsp;
21+
22+
23+
24+
[<img height="58" width="200" src="https://user-images.githubusercontent.com/70570645/171866795-52c11b49-0728-4229-b073-4b704209ddde.png">](https://accounts.lambdatest.com/register?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample)
25+
26+
27+
The **SmartUI-CLI** allows you to capture visual snapshots of your web applications, upload images, and run visual regression tests using [LambdaTest's SmartUI](https://www.lambdatest.com/visual-regression-testing) platform directly from the command line.
628

729
- [Installation](#installation)
8-
- [Start using CLI](#start-using-cli)
30+
- [Commands](#commands)
31+
- [Documentation](#documentation)
32+
- [Issues](#issues)
933

1034
## Installation
1135

1236
```sh-session
13-
$ npm install -g @lambdatest/smartui-cli --force
37+
$ npm install smartui-cli
1438
```
1539

16-
## Start using CLI
40+
## Commands
41+
- `npx smartui exec` - Capture DOM assets for visual testing across multiple browsers and resolutions.
42+
- `npx smartui capture` - Bulk capture static URLs for visual testing.
43+
- `npx smartui upload` - Upload custom images or screenshots for visual comparison.
44+
- `npx smartui upload-figma` - Upload Figma design images for visual comparison.
45+
- `npx smartui config` - Creates configuration file according to the usecase.
1746

18-
#### Create URL Json file
19-
```sh-session
20-
$ smartui config:web-static urls.json
21-
```
47+
### Documentation
2248

23-
#### Create custom Web Config file
24-
```sh-session
25-
$ smartui config:create-web smartui-web.json
26-
```
49+
In addition to its core functionalities, the SmartUI CLI leverages LambdaTest's cloud infrastructure for robust, scalable visual regression testing across various browsers and devices.
2750

28-
#### Configure your Project Token
51+
- [SmartUI Selenium SDK](https://www.lambdatest.com/support/docs/smartui-selenium-java-sdk) - A complete SDK to capture DOM assets for visual tests.
52+
- [LambdaTest Documentation](https://www.lambdatest.com/support/docs/) - Official LambdaTest documentation for SmartUI and other integrations.
53+
- [Bulk capturing static URLs with SmartUI](https://www.lambdatest.com/support/docs/smartui-cli/) - Documentation for capturing satatic urls in bulk with SmartUI
54+
- [Bring your own screenshots](https://www.lambdatest.com/support/docs/smartui-cli-upload/) - Documentation for capturing satatic urls in bulk
55+
- [Figma CLI](https://www.lambdatest.com/support/docs/smartui-cli-figma/) - Documentation for uploading figma components to SmartUI
2956

30-
Create a new web project from [SmartUI Dashboard](https://smartui.lambdatest.com/) and copy the project token and set on CLI via command
57+
### Issues
3158

32-
<b>For Linux/macOS:</b>
59+
If you encounter problems with SmartUI-CLI, [add an issue on GitHub](https://github.com/LambdaTest/smartui-cli/issues/new).
3360

34-
```
35-
export PROJECT_TOKEN="****-****-****-************"
36-
```
61+
For other support issues, reach out via [LambdaTest Support](https://www.lambdatest.com/support).
3762

38-
<b>For Windows:</b>
63+
------
3964

40-
```
41-
set PROJECT_TOKEN="****-****-****-************"
42-
```
43-
44-
#### Capture Screenshots
45-
```sh-session
46-
$ smartui capture urls.json --config smartui-web.json
47-
```
65+
[Know more](https://www.lambdatest.com/visual-regression-testing) about SmartUI and it's AI enabled comparison engines.

0 commit comments

Comments
 (0)