Quick start

RequirementsCopy Anchor Link

You need Python 3.12+, a Node.js runtime compatible with Appium, and the SDK for the platform you want to test:

• Android Studio and the Android SDK for Android.
• Xcode and its command-line tools for iOS on macOS.

Yewo runs on macOS, Linux, and Windows. Apple device tooling exists only on macOS, so iOS testing requires a macOS host:

InstallCopy Anchor Link

Install Yewo from PyPI with uv:

uv tool install yewo

If you prefer an existing virtual environment, use python -m pip install yewo instead. You only need to clone the repository when contributing to Yewo itself.

Prepare a projectCopy Anchor Link

From the app project you want to test, create a starter configuration and prepare Appium for one platform:

yewo setup --platform android

Use --platform ios for an iOS project. Setup previews each required change and asks before creating files or installing tools. It does not overwrite an existing yewo.yaml.

Add credentialsCopy Anchor Link

yewo.yaml configures two kinds of model. A semantic model reads the screen. A grounder returns screen coordinates. Each one names a provider.

Add a credential for every provider your yewo.yaml names. Put the values in the generated .env file or in your shell environment:

<PROVIDER>_API_KEY=your_key_here

Yewo checks these credentials before it starts any device work. A missing credential stops the run, and the error names the variable it wanted.

Choose your models covers which providers you need, and why one provider sometimes needs only one key.

Check the environmentCopy Anchor Link

yewo doctor

yewo doctor checks the project and host environment and explains failures.

Run one goalCopy Anchor Link

Settings come from the nearest yewo.yaml, and command-line options can override its app, device, platform, model, output directory, and execution limits:

yewo run "Open the app and sign in" --app-path path/to/app.apk

Use yewo run for one goal. Use yewo test when a declared journey must produce generated scenarios, independent verdicts, and reusable reports.