Choose a path
SHAFT is a Java test framework (io.github.shafthq:shaft-engine). This guide is a set of jobs. Open the one that matches what you have today. Pages that explain how SHAFT works stay on the site for search and for agents, and they are not in this list.
| You are | Path | Done when |
|---|---|---|
| Starting from nothing | Create a project and run the sample | The sample test runs and the report is on disk |
| Already have a Maven test project | Upgrade a Java project | The project compiles on current SHAFT and one test runs |
| Already have a coding agent | Install SHAFT skills | A new agent session loads $shaft-developer |
| Working in IntelliJ IDEA | Use the IntelliJ plugin | Tools | SHAFT | Open SHAFT opens and setup verifies |
| Using Codex, Copilot, Claude, or another MCP client | Connect an MCP client | The client lists SHAFT tools and one tool call returns |
| Staying in the terminal | Use shaft-cli | shaft-cli runs one command |
| Putting the suite on a server | Run the suite in CI | The pipeline runs the suite headlessly and keeps the report |
| Already running SHAFT, need another kind of test | Add a test surface | One new web, API, mobile, Flutter, database, CLI, or contract check runs |
| Missing Android, Appium, Grid, or browsers | Install local infrastructure | shaft-cli setup verify passes for the profile you chose |
| Want the project-local agent harness | Install ChaosEngine | The installer prints a successful JSON result |
mvn test
That command is the check for a generated or upgraded project. Other paths name their own check on the page.