Open an existing project or create a new project in Xcode.

Follow these steps if you’re creating a new project.

Choose App

Ensure Include Tests is checked

In the top menu bar go to File -> Add package dependencies

In the search field in the top right corner paste https://github.com/qaml-ai/qaml-swift

Select your UITest target, NOT your main app target.

Selecting UITest target

Include import qaml at the top of your test file

Note, this test case will only work if you have Apple weather app on your device. Example test:

import XCTest
import qaml

final class test_sampleTest: XCTestCase {

    func test_weatherApp_weatherInSF() throws {
        let app = XCUIApplication(bundleIdentifier: "com.apple.weather")
        app.launch()
        
        let q = QamlClient(
            apiKey: "<API_KEY>",
            app: app
        )
        
        q.execute("click the location list button")
        q.execute("tap the search bar at the top")
        q.execute("type San Francisco")
        q.execute("tap the first result in the location list, 'San Francisco, CA United States'")
        q.assertCondition("The screen shows the weather for San Francisco")
    }
}

Select the device you’d like to run your test on at the top.

• For physical devices, attach your device to your computer via USB.
• For simulated devices, select your desired device from the drop down menu.
• For third party device farms, following their XCUITest documentation.
• AWS Docs, Sauce Labs Docs, Browserstack Docs.