SeeTestAutomation - Keyle - Command Line Interface For iOS Applications Instrumentation
Please note that this tool is classified as a Legacy tool. We recommend transitioning to our updated solutions to maintain optimal performance and security in your workflows. For more information on this matter, please reach out to technical support .
Keyle is a CLI tool that allows users to instrument their iOS application (IPA files) from a shell environment (MAC and Windows).
Keyle allows SeeTestAutomation users to select a specific provision profile to sign their application during the instrumentation process (otherwise, SeeTestAutomation will select random provision profile).
Prerequisites
- Installed SeeTestAutomation (version 9.7 and above).
- The selected provision profile must be imported to SeeTestAutomation, for more information go to iOS Profile Mangement.
Commands Description
| command | parameters | Description |
|---|---|---|
| help | none | print help message to the console |
| list-provisions | none | Prints a list of valid provision profiles with their UUID (Universal Unique identification) |
| info | Prints the application version and Bundle ID | |
| -app <path> | Full path to the application (...\folder\app.ipa) | |
| instrument | instrument the application | |
| -app <path> | Full path to the application (...\folder\app_v2.ipa) | |
| -profile <UUID> | The UUID of the provisioning profile | |
| -outIPA <path> | Full path to the application (...\folder\app.ipa) | |
| [-basic] | Instrument with basic capabilities only (doesn't include: Simulate Capture, Mock Authentication) | |
| [-t <timeout>] | Set timeout (in seconds) for the instrumentation process, default set to 300 seconds | |
| [-entitlements <path>] | Full path to entitlements file (UTF-8 encoding) | |
| [-v] | Verbose (print log to console) | |
| resign | signs the application | |
| -app <path> | Full path to the application (...\folder\app_v2.ipa) | |
| -profile <UUID> | The UUID of the provisioning profile | |
| -outIPA <path> | Full path to the application (...\folder\app.ipa) | |
| [-t <timeout>] | Set timeout (in seconds) for the instrumentation process, default set to 300 seconds | |
| [-entitlements <path>] | Full path to entitlements file (UTF-8 encoding) | |
| [-v] | Verbose (print log to console) | |
| entitlements | Prints the entitlements plist of the application | |
| -app <path> | Full path to the application (...\folder\app_v2.ipa) |
Installing instrumented application
To install the application on the device you can use the install command when instrument argument is set to false.
The application can be imported to SeeTest, Cloud Server or installed directly from local disk.
client.install("com.experitest.UICatalog", false, false)
Usage Examples
Usage: info -app <path>
C:\Program Files (x86)\SeeTest>keyle info -app c:\Applications\iOS\UICatalog.ipa
IPA file path: c:\Applications\iOS\UICatalog.ipa
Bundle ID: com.experitest.UICatalog
Bundle Version: 1207
Usage: list-provisions
C:\Program Files (x86)\SeeTest>keyle list-provisions
Provisions profile list:
# - UUID - - Name - - AppID - - Type - - Expiration -
1 23432fxd-e75b-gfds-9707-5be17c7fdb94 AutomationTeam 97625FEAFA.* Development 168 days
2 432hcvfb-d245-4321-93fb-af7d9e794e5c General Signing 97625FEAFA.* Development 168 days
3 sdadgfew-3b0d-4b1e-4236-f37537d31ed9 QA_Test 97625FEAFA.* Development 168 days
Usage: entitlements -app <path>
C:\Program Files (x86)\SeeTest>keyle entitlements -app c:\Applications\iOS\UICatalog.ipa >> C:\Users\Yotam\app_entitlements.txt
Usage: instrument -app <path> -outIPA <path> -profile <UUID>
C:\Program Files (x86)\SeeTest>keyle instrument -app c:\Applications\iOS\UICatalog.ipa -outIPA c:\Applications\iOS\UICatalog_v2.ipa -profile 432hcvfb-d245-4321-93fb-af7d9e794e5c -entitlements "C:\Users\Yotam\app_entitlements.txt"
Start Instrumentation ...
Created ipa c:\Yotam\Featurs\Keyle\UICatalog_v2.ipa
- Verify the entitlements text file is encoded in UTF-8
- Can be verified when opening file in a text editor app (such as Notepad++)