adb-ready 0.0.1-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,65 @@
1
+ # ADB Ready
2
+
3
+ > Make an Android target ready, then keep the development session working.
4
+
5
+ ADB Ready is an early-alpha, Android-only developer CLI built around the real
6
+ `adb` executable. This release establishes the portable and scriptable
7
+ foundation for the broader development-session workflow.
8
+
9
+ ## Try the alpha
10
+
11
+ ADB Ready currently requires Node.js 22 or newer and an installed Android SDK
12
+ Platform-Tools `adb` executable.
13
+
14
+ ```bash
15
+ npx adb-ready@alpha
16
+ npx adb-ready@alpha doctor
17
+ npx adb-ready@alpha devices
18
+ ```
19
+
20
+ The package also exposes the shorter `adbr` command. Both names invoke the same
21
+ CLI entrypoint.
22
+
23
+ ## Available now
24
+
25
+ - Interactive keyboard-driven home screen.
26
+ - Read-only environment and ADB diagnostics with `doctor`.
27
+ - Read-only Android target discovery with `devices`.
28
+ - Deterministic target selection through `--select`.
29
+ - Human, plain, JSON, and NDJSON output.
30
+ - Explicit ADB executable, server host, server port, timeout, and presentation
31
+ controls.
32
+ - Portable execution through Node, Bun, and Deno.
33
+
34
+ Run `npx adb-ready@alpha --help` for the complete command reference.
35
+
36
+ ## Runtime and package-manager entrypoints
37
+
38
+ The same npm package can be launched through the common JavaScript package
39
+ managers:
40
+
41
+ ```bash
42
+ npx adb-ready@alpha doctor
43
+ pnpm dlx adb-ready@alpha doctor
44
+ yarn dlx adb-ready@alpha doctor
45
+ bunx adb-ready@alpha doctor
46
+ ```
47
+
48
+ Explicit alternative runtimes are also supported:
49
+
50
+ ```bash
51
+ bunx --bun adb-ready@alpha doctor
52
+ deno run -A npm:adb-ready@alpha doctor
53
+ ```
54
+
55
+ ## Alpha scope
56
+
57
+ Wireless pairing and recovery, reverse and forward ports, Expo and React Native
58
+ presets, and the flagship `adb-ready dev` session are not included yet. The
59
+ current commands are intentionally read-only and never restart the ADB server
60
+ or mutate a connected device.
61
+
62
+ This preview is published to validate the CLI foundation and reserve the
63
+ canonical package name during active development. The source repository remains
64
+ private during the early implementation phase, and this alpha is currently
65
+ distributed as `UNLICENSED` software.