SmartUI CLI Exec Command
SmartUI CLI exec command offers you various options to manage snapshot server and execute your visual testing scripts. This guide will walk you through the available commands and their usage.
Prerequisites
- Basic understanding of Command Line Interface
- SmartUI CLI version 4.1.43 or higher installed for the start, stop and ping commands
- A properly configured SmartUI CLI project
Available Commands
SmartUI CLI offers the following exec commands:
npx smartui exec- Execute a command with SmartUI server runningnpx smartui exec:start- Start the SmartUI snapshot servernpx smartui exec:stop- Stop the SmartUI snapshot servernpx smartui exec:ping- Check if the SmartUI server is running (uses custom HTTP client)npx smartui exec:pingTest- Check if the SmartUI server is running (uses default HTTP client)
Using the Exec Command
The npx smartui exec command allows you to run your tests with various configuration options. Here's the basic syntax:
npx smartui exec [options] -- <command>
Available Options
| Option | Description |
|---|---|
-P, --port <number> | Specify a custom port number for the server (default: 49152) |
--fetch-results [filename] | Fetch test results and save to a JSON file (default: results.json) |
--buildName <string> | Specify a custom build name for the test run |
--scheduled <string> | Specify the schedule ID for scheduled test runs |
--show-render-errors | Show render errors from SmartUI build |
--userName <string> | Override TestMu AI username (overrides environment variable) |
--accessKey <string> | Override TestMu AI access key (overrides environment variable) |
--config <file> | Specify a configuration file to use |
-h, --help | Display help information |
Examples
- Running with a custom port:
npx smartui exec -P 5000 -- npm test
- Fetching results with custom filename:
npx smartui exec --fetch-results custom-results.json -- npm test
- Specifying a build name:
npx smartui exec --buildName "Release-1.0" -- npm test
- Using a configuration file:
npx smartui exec --config smartui-config.json -- npm test
- Combining multiple options:
npx smartui exec -P 5000 --buildName "Release-1.0" --config smartui-config.json --fetch-results -- npm test
- Running scheduled tests:
npx smartui exec --scheduled "schedule-123" -- npm test
- Showing render errors:
npx smartui exec --show-render-errors -- npm test
- Overriding credentials:
npx smartui exec --userName "user" --accessKey "key" -- npm test
Starting the Server
To start the SmartUI snapshot server:
Verifiednpx smartui exec:start
This will start a local server that handles snapshot requests. By default, the server runs on port 49152.
Stopping the Server
To properly stop the SmartUI snapshot server:
Verifiednpx smartui exec:stop
Important: It's recommended to use the
exec:stopcommand rather than using Ctrl+C to terminate the server. Using Ctrl+C will cause the build to stop after 12 minutes of running.
Checking Server Status
To verify if the SmartUI server is running, you can use either of these commands:
Using exec:ping (custom HTTP client):
Verifiednpx smartui exec:ping
Using exec:pingTest (default HTTP client):
Verifiednpx smartui exec:pingTest
Both commands check if the server is running at the address specified in SMARTUI_SERVER_ADDRESS environment variable (default: http://localhost:49152).
Running Tests with the Server
Step 1: Configure Server Address
For most test frameworks (except Selenium Java and JavaScript), you'll need to set the server address:
Verified- MacOS/Linux
- Windows - CMD
- PowerShell
export SMARTUI_SERVER_ADDRESS='http://localhost:49152'
set SMARTUI_SERVER_ADDRESS='http://localhost:49152'
$env:SMARTUI_SERVER_ADDRESS="http://localhost:49152"
Step 2: Execute Your Tests
You can run your tests using your preferred test runner:
Verified# Using npm
npm test
# Using Maven
mvn test
# Using other test runners
your-test-command
IDE Configuration
When running tests from IDEs like IntelliJ:
- Ensure the
SMARTUI_SERVER_ADDRESSenvironment variable is set in your IDE's run configuration - Configure the run configuration to use the appropriate test command
Best Practices
- Server Termination
- Timeouts
- Snapshot Naming
- Environment Variables
- Configuration Files
Server Termination
Always use exec:stop to properly terminate the server.
Timeouts
Set appropriate timeouts for your tests.
Snapshot Naming
Use meaningful names for your snapshots.
Environment Variables
Configure environment variables before starting your IDE.
Configuration Files
Consider using configuration files for complex setups.
Troubleshooting
- Server Status
- Server Address
- Port Conflicts
- Server Logs
Server Status
Verify the server is running using exec:ping.
Server Address
Check if the server address is correctly configured.
Port Conflicts
Ensure no other process is using the default port.
Server Logs
Review the server logs for error messages.
Getting Help
If you encounter issues not covered here:
- Review the Comprehensive Troubleshooting Guide for detailed solutions
- Check CLI Documentation for general CLI usage
- Visit TestMu AI Support for additional resources
- Contact support at support@testmuai.com or use 24/7 Chat Support
Chat with Us