|
| 1 | +# SmartUI-CLI |
| 2 | + |
| 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 | + ⋅ |
| 8 | + <a href="https://www.lambdatest.com/support/docs/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Docs</a> |
| 9 | + ⋅ |
| 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 | + ⋅ |
| 12 | + <a href="https://www.lambdatest.com/newsletter/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Newsletter</a> |
| 13 | + ⋅ |
| 14 | + <a href="https://www.lambdatest.com/certifications/?utm_source=github&utm_medium=repo&utm_campaign=playwright-sample" target="_bank">Certifications</a> |
| 15 | + ⋅ |
| 16 | + <a href="https://www.youtube.com/c/LambdaTest" target="_bank">YouTube</a> |
| 17 | +</p> |
| 18 | +  |
| 19 | +  |
| 20 | +  |
| 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. |
| 28 | + |
| 29 | +- [Installation](#installation) |
| 30 | +- [Commands](#commands) |
| 31 | +- [Documentation](#documentation) |
| 32 | +- [Issues](#issues) |
| 33 | + |
| 34 | +## Installation |
| 35 | + |
| 36 | +```sh-session |
| 37 | +$ npm install smartui-cli |
| 38 | +``` |
| 39 | + |
| 40 | +**Note:** |
| 41 | +If you face any problems executing tests with SmartUI-CLI `versions >= v4.x.x`, upgrade your Node.js version to `v20.3` or above. |
| 42 | + |
| 43 | +## Commands |
| 44 | +- `npx smartui exec` - Capture DOM assets for visual testing across multiple browsers and resolutions. |
| 45 | +- `npx smartui capture` - Bulk capture static URLs for visual testing. |
| 46 | +- `npx smartui upload` - Upload custom images or screenshots for visual comparison. |
| 47 | +- `npx smartui upload-figma` - Upload Figma design images for visual comparison. |
| 48 | +- `npx smartui config` - Creates configuration file according to the usecase. |
| 49 | + |
| 50 | +### Documentation |
| 51 | + |
| 52 | +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. |
| 53 | + |
| 54 | +- [SmartUI Selenium SDK](https://www.lambdatest.com/support/docs/smartui-selenium-java-sdk) - A complete SDK to capture DOM assets for visual tests. |
| 55 | +- [LambdaTest Documentation](https://www.lambdatest.com/support/docs/) - Official LambdaTest documentation for SmartUI and other integrations. |
| 56 | +- [Bulk capturing static URLs with SmartUI](https://www.lambdatest.com/support/docs/smartui-cli/) - Documentation for capturing satatic urls in bulk with SmartUI |
| 57 | +- [Bring your own screenshots](https://www.lambdatest.com/support/docs/smartui-cli-upload/) - Documentation for capturing satatic urls in bulk |
| 58 | +- [Figma CLI](https://www.lambdatest.com/support/docs/smartui-cli-figma/) - Documentation for uploading figma components to SmartUI |
| 59 | + |
| 60 | +### Issues |
| 61 | + |
| 62 | +If you encounter problems with SmartUI-CLI, [add an issue on GitHub](https://github.com/LambdaTest/smartui-cli/issues/new). |
| 63 | + |
| 64 | +For other support issues, reach out via [LambdaTest Support](https://www.lambdatest.com/support). |
| 65 | + |
| 66 | +------ |
| 67 | + |
| 68 | +[Know more](https://www.lambdatest.com/visual-regression-testing) about SmartUI and it's AI enabled comparison engines. |
0 commit comments