Your first all-in-one Ruviolta workspace.
Start from an empty folder with one readable .ut (User Testing) language for Web, API and Android. The standard install stays lightweight; Android support is downloaded only when you explicitly initialize it.
Before you install
Node.js 18+
Ruviolta runs through Node.js and npm on Windows and Linux.
Browser for Web tests
Install Chrome, Edge or Firefox for browser automation. Pure API and Android tests do not need to launch a desktop browser.
Android is optional
The virtual Android runtime is provisioned only after ruviolta android init. Real devices require USB debugging authorization.
VS Code optional
The 3.0.1 extension adds Web, API and Android syntax, diagnostics, snippets and run/debug commands.
Install, initialize, then choose a flow
1. Create a Node project
npm init -y-y is optional and accepts the default package.json answers automatically.
2. Install Ruviolta from npm
npm install -g ruviolta3. Verify and initialize
ruviolta --version
ruviolta initnpx runs the locally installed Ruviolta binary. npm ruviolta init is not an npm command form; npm exec -- ruviolta init is the npm-exec equivalent.
Initialization creates the UI example, the reusable cross-project example, and the API example. Running init again refreshes Ruviolta's official demo template files to the current version while leaving additional user-created files untouched.
4. Run UI, API-only or mixed UI + API
# Browser UI example
ruviolta run projects/example "@exampleDomain"
# API-only example
ruviolta run projects/api-example "@getPost"
# Mixed UI → API → UI example
ruviolta run projects/api-example "@uiAndApi"
# Debug the mixed flow step by step
ruviolta debug projects/api-example "@uiAndApi"If Ruviolta is installed only inside this Node project and the executable is not on PATH, use the same commands with an npx prefix.
Provision Android only when you choose mobile testing
ruviolta android init
ruviolta mobile start android
ruviolta mobile app install android projects/android/demoData/Ruviolta-Demo-1.1.2.apk
ruviolta run projects/android "@demoTest"
ruviolta mobile stop androidAutomatic platform download
ruviolta android init detects the host operating system, downloads the verified Windows or Linux Android package, and creates the editable projects/android example without overwriting existing files.
The heavy runtime stays outside your workspace under ~/.ruviolta/mobile/android/ on Linux or %LOCALAPPDATA%\Ruviolta\mobile\android\ on Windows. Re-running init reuses an intact verified runtime.
Virtual Android
Use the managed Ruviolta Emulator, install the included demo APK and run the generated example flow.
Real Android
Set android.device.type to "real", connect a supported Android device and authorize USB debugging. The same test files and commands are used.
What init creates in 3.0.1
Three examples, one runtime
example demonstrates browser UI automation, cross-project demonstrates reusable flows, and api-example demonstrates both API-only and mixed UI + API execution.
Each generated project includes an editable tests/login/login.ut template and a matching login.flow reference in its config. Automatic login is disabled by default; after you adapt the template to your application, set login.enabled to true to run that flow once before the requested scenarios. Your projects stay outside node_modules and keep the same config / tests / reports layout.
Web, API, Android or a mixed flow
Web UI
Configure baseUrl and a browser, then use browser commands and retryable UI verifications.
API-only
Configure api.baseUrl. No browser is launched.
Android
Choose a virtual or real device and use native mobile commands in normal scenarios.
Mixed
Reuse projects and flows across the same all-in-one testing platform.