Skip to content

Commit 8fe85b8

Browse files
authored
Merge pull request #13 from sushobhit-lt/stage
update README file
2 parents 07f60d9 + 72da66c commit 8fe85b8

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

packages/cli/README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# SmartUI CLI
2+
[![SmartUI-Testing](https://smartui.lambdatest.com/static/media/LTBadge.64a05e73.svg)](https://smartui.lambdatest.com)
3+
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.
6+
7+
- [Installation](#installation)
8+
- [Start using CLI](#start-using-cli)
9+
10+
## Installation
11+
12+
```sh-session
13+
$ npm install -g @lambdatest/smartui-cli --force
14+
```
15+
16+
## Start using CLI
17+
18+
#### Create URL Json file
19+
```sh-session
20+
$ smartui config:web-static urls.json
21+
```
22+
23+
#### Create custom Web Config file
24+
```sh-session
25+
$ smartui config:create-web smartui-web.json
26+
```
27+
28+
#### Configure your Project Token
29+
30+
Create a new web project from [SmartUI Dashboard](https://smartui.lambdatest.com/) and copy the project token and set on CLI via command
31+
32+
<b>For Linux/macOS:</b>
33+
34+
```
35+
export PROJECT_TOKEN="****-****-****-************"
36+
```
37+
38+
<b>For Windows:</b>
39+
40+
```
41+
set PROJECT_TOKEN="****-****-****-************"
42+
```
43+
44+
#### Capture Screenshots
45+
```sh-session
46+
$ smartui capture urls.json --config smartui-web.json
47+
```

0 commit comments

Comments
 (0)