pj/sanderling

0 Fork 0

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

Files

T

pj e62319e916 docs: pandoc-based site and v0.1.0 groundwork (#5 )

* chore(prose): remove em-dashes from config files

* chore(prose): remove em-dashes from android sdk config

* docs(spec-api): remove em-dash from README

* fix(doctor): reword sidecar-jar error without em-dash

* test(sidecar): reword assertion message without em-dash

* docs: add CLAUDE.md with project conventions

* build: add docs target for pandoc site

* docs(site): add pandoc template and stylesheet

* docs(site): add pandoc build script

* docs(site): add landing pages

* docs(manual): add getting-started

* docs(manual): add writing-specs

* docs(manual): add runs

* docs(manual): add cli reference

* docs(dev): add design principles

* docs(dev): add architecture

* ci: deploy docs site to github pages

* docs: rewrite README as entry point to docs site

2026-04-18 14:00:57 +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 uatu Android SDK linked in.
adb on your PATH.

Run uatu doctor to check the host environment.

Install

CLI

macOS arm64:

curl -L https://github.com/priyanshujain/uatu/releases/latest/download/uatu_<version>_darwin_arm64.tar.gz | tar xz
./uatu version

Linux amd64:

curl -L https://github.com/priyanshujain/uatu/releases/latest/download/uatu_<version>_linux_amd64.tar.gz | tar xz
./uatu version

Pre-built for darwin/arm64, darwin/amd64, linux/amd64, linux/arm64.

Spec package (npm)

npm install --save-dev @uatu/spec

Android SDK (Maven Central)

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

Your first run

The repo ships a working sample at examples/sample-app. From that directory:

./gradlew :sample-app:installDebug
uatu test \
  --spec spec.ts \
  --bundle-id dev.uatu.sample \
  --platform android \
  --avd Pixel_7 \
  --duration 2m

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

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

Open the screenshots directory to scrub visually, or read trace.jsonl step by step.

Next: writing specs.

1.5 KiB Raw Blame History