Quickstart

Run Minecraft plugin tests on a disposable VM from your own machine. No server SSH access is needed: the client talks to Pericynth over HTTPS with your account token.

Create an account and a token. Sign up at /login with email and password (verify the address first), or use Google or GitHub. Open the account page, create a personal API token and copy it once.
Prepare the client. Keep the repository checkout with client/ci.py, install the WebSocket dependency and expose the token to the process:
```
python3 -m pip install -r client/requirements.txt
export PERICYNTH_API_TOKEN="pca_..."
```
Point the client at this site. Edit client/service.json next to the client:
```
{
  "url": "https://pericynth.example",
  "timeoutSeconds": 30,
  "pollIntervalSeconds": 0.5
}
```
Add "caFile": "/path/to/ca.pem" only when the service uses a private certificate authority.
Describe the test. Keep your project settings in ci.json and your test steps under tests/. See the docs for the JSON schema.

Run it. The run streams logs, saves them under logsDir/RUN_ID/ and exits 0 when the assertions pass:

./gradlew runCI             # assertions, then exit
./gradlew runCI --keep-open # interactive prompt after the tests

While a session is kept open you can open the printed browser link to watch or control a player, use join at the ci> prompt to print a local Minecraft address, or observe a running session with python3 client/ci.py --view RUN_ID player0. Observers never stop the run; Ctrl+C or closing standard input in the owning client stops it gracefully. Saved reports for runs you submitted are private to your account, so sign in before opening a report link.