pj/sanderling

0 Fork 0

mirror of https://github.com/priyanshujain/sanderling.git synced 2026-10-02 19:17:10 +00:00

Files

T

pj 75780db3fa refactor(sdk-android): publish under io.github.priyanshujain.sanderling + ci docs fix (#27 )

* refactor(sdk-android): publish under io.github.priyanshujain.sanderling

Move the published Maven coordinates to a sanderling sub-namespace so the
brand is visible in the dependency line (was io.github.priyanshujain:sdk-android).
Sub-namespace is auto-allowed by Sonatype under the verified parent groupId.

* chore: update sdk-android coordinates in folio + docs

Follow the groupId change to io.github.priyanshujain.sanderling:sdk-android.

* ci(docs): use --version flag for d2 install script

The d2 installer accepts --version vX.Y.Z, not --tag. The --tag form
was rejected as "unrecognized flag" on the docs workflow run after
PR #26 merged.

2026-04-21 15:17:56 +07:00

1.5 KiB

Raw Blame History

title

title
Getting started

Getting started

Install the CLI, link the SDK into your debug build, run a spec.

Prerequisites

An Android emulator with API level 30 or newer.
The app under test built as a debug variant with the sanderling Android SDK linked in.
adb on your PATH.

Run sanderling doctor to check the host environment.

Install

CLI

curl -fsSL https://raw.githubusercontent.com/priyanshujain/sanderling/master/install.sh | bash

Spec package (npm)

npm install --save-dev @sanderling/spec

Android SDK (Maven Central)

dependencies {
    implementation("io.github.priyanshujain.sanderling:sdk-android:<version>")
}

Your first run

The repo ships a working sample at examples/folio, a Kotlin Multiplatform app with a TypeScript spec under sanderling/spec.ts. Install just, then from examples/folio:

just install   # build and install the folio APK on a booted emulator or device
just test      # run the spec

With no device connected and multiple AVDs, pick one:

AVD=Pixel_7 just test

Persistent settings can live in a .env alongside the justfile (AVD=Pixel_7, DURATION=5m, and so on).

When the run ends, the trace lands in sanderling/runs/<timestamp>/:

runs/2026-04-18T12-34-56/
├── trace.jsonl
├── screenshots/
└── meta.json

Browse it with sanderling inspect (see inspect), or read trace.jsonl step by step.

Next: writing specs.

1.5 KiB Raw Blame History