Skip to main content

Platform and setup updates

Start here when you need to install SHAFT, upgrade a project, or prepare an execution service. Open the full guide for exact commands and environment rules.

Modular artifacts and BOM

What it does
Split SHAFT into a core engine and optional artifacts while one BOM aligns their versions.
Why use it
Install only the capabilities your project uses without managing each SHAFT version separately.
Configure
Import shaft-bom in dependencyManagement, then omit versions from SHAFT dependencies.
Use it
Add shaft-engine and only the optional artifacts needed by the project.
Open full guide

Automated upgrade tool

What it does
Migrates supported older SHAFT, Selenium, Appium, and REST Assured projects to modular coordinates and current APIs.
Why use it
Produce a reviewable migration instead of editing dependencies and calls by hand.
Configure
Run the upgrader from the existing project root and review its generated changes.
Use it
Build and test the migrated project before committing it.
Open full guide

Project Generator

What it does
Creates a ready-to-run Maven project from selected runner and test surfaces.
Why use it
Start with working SHAFT structure and dependencies.
Configure
Choose the project options in the generator, then download the result.
Use it
Open the generated project and run mvn test.
Open full guide

Properties Generator

What it does
Builds a focused SHAFT properties file from the supported configuration catalog.
Why use it
See available controls and keep only intentional overrides.
Configure
Select properties in the generator and copy the output into the project.
Use it
Place the file on the test classpath, then run the test suite.
Open full guide

Managed local AI runtime

What it does
Installs supported local agent tooling and required runtimes through the project installer.
Why use it
Set up repeatable local tools without hand-assembling their runtime commands.
Configure
Choose the documented installer flags for the tools the workstation needs.
Use it
Run installer verification, then connect the installed CLI, MCP, or skills surface.
Open full guide

Android and Appium setup

What it does
Prepares Android SDK, emulator, Appium, and driver prerequisites for SHAFT mobile tests.
Why use it
Catch missing infrastructure before the first mobile session.
Configure
Install the documented Android and Appium components and set their required environment values.
Use it
Start the target device, then run the mobile quick-start test.
Open full guide

iOS and Windows Appium setup

What it does
Documents the platform-specific drivers and hosts required for iOS and Windows application sessions.
Why use it
Use the correct Appium driver on a compatible host.
Configure
Install the platform driver and follow its host-specific prerequisites.
Use it
Create the matching mobile session and run a focused smoke test.
Open full guide

Selenium Grid preflight

What it does
Checks remote Grid connectivity and browser availability before execution.
Why use it
Fail early with an actionable setup error instead of a late driver timeout.
Configure
Set the remote execution address and browser settings in SHAFT properties.
Use it
Run the preflight, then start the web suite against the Grid.
Open full guide

Healenium setup

What it does
Connects SHAFT web execution to a Healenium service when that integration is selected.
Why use it
Use service-backed locator recovery in environments that already operate Healenium.
Configure
Start the documented Healenium services and set the SHAFT integration properties.
Use it
Run a focused web test and inspect recovered locator evidence.
Open full guide

ReportPortal setup

What it does
Connects test execution to a configured ReportPortal instance.
Why use it
Send run events to the team reporting service when ReportPortal is part of the toolchain.
Configure
Provide the documented endpoint, project, and authentication settings through secure configuration.
Use it
Run a test and confirm its launch appears in ReportPortal.
Open full guide

BrowserStack Local

What it does
Creates a secure tunnel between BrowserStack sessions and sites reachable from the test machine.
Why use it
Test local or private environments on BrowserStack devices and browsers.
Configure
Add shaft-browserstack, supply credentials securely, and enable the local tunnel settings.
Use it
Start a remote session against the private target and close the tunnel after the run.
Open full guide

Playwright browser installation

What it does
Installs the browser binaries required by SHAFT's Playwright backend.
Why use it
Avoid session startup failures caused by missing managed browsers.
Configure
Run the documented Playwright browser installation command for the target environment.
Use it
Create a SHAFT Playwright session and run a smoke test.
Open full guide

Lighthouse setup

What it does
Prepares the browser tooling used by SHAFT performance audits.
Why use it
Run repeatable Lighthouse checks from the test workflow.
Configure
Install the documented runtime prerequisites and enable the audit settings.
Use it
Run the audit against a stable page and review the attached report.
Open full guide

Verify the selected setup with a focused run:

mvn test