Skip to content
OpenCharly

plugin-adb
Placement runtime (out-of-process over gRPC)
Source github.com/opencharly/charly/candy/plugin-adb
Version 2026.180.0001
Candy plugin-adb

This plugin is not listed in charly/charly.yml’s compiled_plugins:. It is not part of the shipped binary: charly builds and loads it out-of-process over gRPC when a plan references one of its words (the coexist path).

Providers

Section titled “Providers”

The reserved words this plugin serves:

  • android — deploy class
  • adb — verb class

What it does

Section titled “What it does”

OUT-OF-TREE charly plugin owning ALL Android device interaction: the adb Android-Debug-Bridge check VERB, the deploy:android SUBSTRATE (the target: android app-install deploy, F1), AND the goadb-backed device probe the charly status collector needs — a standalone Go module (go.mod

  • main.go) that speaks the ADB wire protocol over go-plugin gRPC via the charly plugin SDK (github.com/opencharly/sdk). charly’s loader fetches this candy’s repo, go-builds the provider binary on the HOST, and serves it OUT-OF-PROCESS via LocalTransport — so the github.com/zach-klippenstein/goadb dependency + the SINGLE apk install path (apkeep + adb, R3) live HERE, out of charly’s core go.mod. Authoring is unchanged: the adb: <method> sugar desugars to plugin/plugin_input — the method + every adb-exclusive modifier ride the input map, validated against this plugin’s own #AdbInput (ResolveVerb → grpcProvider → invokeVerbProvider hands it the full desugared #Op) — and target: android resolves to this plugin’s deploy:android provider over the E3b reverse channel — THIS plugin’s own preresolve.go (F6, FINAL/K5 unit 6a; dispatched via the generalized deploy_preresolve.go:wireDeployPreresolver seam) resolves the device endpoint + the apk specs, reaching the host’s “deploy-entity-resolve” HostBuild seam for the entity + Google-creds lookup, and ships the result in DeployVenue.Substrate; this plugin gates on boot then installs. Provides the full 12-method verb surface (devices/shell/install/install-app/uninstall/getprop/screencap/ logcat-tail/wait-for-device/wait-ui-settled/current-focus/keyevent) plus the deploy substrate. The R10 consumer is the check-android-emulator-pod bed (via android-emulator-layer).

Parameter schema

Section titled “Parameter schema”

The CUE schema below is the authoritative grammar for this plugin’s input. It is the same single source that generates the plugin’s Go parameter types and answers the runtime Describe RPC, so this page cannot disagree with either.

schema/adb.cue

Section titled “schema/adb.cue”
// This out-of-tree plugin's OWN CUE schema, served over the Describe channel — the
// typed plugin_input for the `adb` Android-Debug-Bridge check verb. It is the SINGLE
// SOURCE for this plugin's params, used two ways (the same contract core `spec` and
// the http plugin use):
//
//  1. GENERATE the Go param struct — `cue exp gengotypes` (driven by task cue:gen,
//     which wraps this with `package params` + `@go(params)`) emits
//     ../params/cue_types_gen.go, so the provider decodes plugin_input into a TYPED
//     struct, never a hand-parsed map.
//  2. VALIDATE authored input AT RUNTIME — the plugin serves this source over the
//     Describe channel; the host splices it onto the base (base ++ plugin) and
//     validates every authored `adb:` step's plugin_input against #AdbInput.
//
// Since the schema-compaction cutover the per-verb fields left core #Op: a step's
// `adb: <method>` sugar desugars to the internal plugin/plugin_input pair, the method
// name rides the input's `method` key (the former core #AdbMethod enum), and every
// adb-exclusive modifier (arg/apk/app_id/source/arch/app_version/property/key/query/
// amount/artifact + the artifact validators) lives HERE. Only the genuinely SHARED
// step modifiers (timeout, the exit_status/stdout/stderr matchers, context, …) stay
// on core #Op, read off the step Op by the provider.
//
// SELF-CONTAINED: it references NO base def, so it compiles standalone (the SDK's
// serve-side check + gengotypes) AND splices onto the base (base ++ plugin is a
// def-name collision check, not a base-reference resolver).
//
// The plugin ALSO serves deploy:android (the `target: android` substrate) — that
// capability keeps its authoring contract on core #Android / the apk: format and
// carries NO plugin_input, so no input def for it lives here.


// #AdbInput is the `adb` verb's plugin_input: the method name plus its
// method-exclusive modifiers.
#AdbInput: {
  // method — the adb method name (the former core #AdbMethod enum; the verb's
  // PRIMARY input field, so `adb: devices` desugars to {method: "devices"}).
  method: ("devices" | "shell" | "install" | "install-app" | "uninstall" | "getprop" | "screencap" | "logcat-tail" | "wait-for-device" | "wait-ui-settled" | "current-focus" | "keyevent") @go(Method,type=string)
  // arg — the shell argv (shell: arg[0] program + arg[1:] args) / the package id
  // (uninstall: arg[0]).
  arg?: [...string] @go(Args)
  // apk — HOST path of a committed APK (install); resolved to an absolute
  // candy-anchored path by the host before marshaling.
  apk?: string
  // app_id / source / arch / app_version — the apkeep package spec (install-app).
  app_id?:      string @go(AppId)
  source?:      string
  arch?:        string
  app_version?: string @go(AppVersion)
  // property — the system property key (getprop), e.g. sys.boot_completed.
  property?: string
  // key — the key event to send (keyevent), e.g. KEYCODE_HOME or a numeric code.
  key?: string @go(KeyName)
  // query / amount — the literal logcat filter spec + last-N-lines trim (logcat-tail).
  query?:  string
  amount?: int @go(,type=int)
  // artifact + validators — screencap's PNG output path and the post-run
  // artifact-reality assertions (sdk.RunArtifactValidators reads them off the input).
  artifact?:                 string
  artifact_min_bytes?:       int & >=0                    @go(ArtifactMinBytes,type=int)
  artifact_min_dimensions?:  string & =~"^[0-9]+x[0-9]+$" @go(ArtifactMinDimensions)
  artifact_not_uniform?:     bool                         @go(ArtifactNotUniform)
  artifact_min_cast_events?: int & >=0                    @go(ArtifactMinCastEvents,type=int)
}

See also the candy reference for this candy’s install surface.