iphone-cli 0.1.6

Let AI agents read and operate any app on a real iPhone through the accessibility tree. No XCUITest, WebDriverAgent or Xcode signing.
Documentation
//! `--human`: the same results, laid out for a person reading a terminal.

use serde_json::Value;

fn s(v: &Value) -> String {
    match v {
        Value::String(s) => s.clone(),
        Value::Null => String::new(),
        other => other.to_string(),
    }
}

fn element_line(e: &Value) -> String {
    let mut line = format!("{:<13}", s(&e["role"]));
    if let Some(l) = e["label"].as_str() {
        line.push_str(&format!(" \"{l}\""));
    }
    if let Some(v) = e["value"].as_str() {
        line.push_str(&format!(" = \"{v}\""));
    }
    if let Some(i) = e["identifier"].as_str() {
        line.push_str(&format!(" #{i}"));
    }
    if let f @ Value::Object(_) = &e["frame"] {
        line.push_str(&format!(
            "  @{},{} {}x{}",
            s(&f["x"]),
            s(&f["y"]),
            s(&f["w"]),
            s(&f["h"])
        ));
    }
    if e["enabled"] == false {
        line.push_str("  (disabled)");
    }
    if e["selected"] == true {
        line.push_str("  (selected)");
    }
    if e["focused"] == true {
        line.push_str("  (focused)");
    }
    if e["on_screen"] == false {
        line.push_str("  (off screen)");
    }
    line.push_str(&format!("  [{}]", s(&e["id"])));
    line
}

fn type_observation(v: &Value, out: &mut Vec<String>) {
    if v.get("value_changed").is_some() {
        let parts: Vec<String> = [
            "verified",
            "value_before",
            "value",
            "value_changed",
            "screen_changed",
            "submit_sent",
        ]
        .iter()
        .map(|key| format!("{key}={}", v[*key]))
        .collect();
        out.push(format!("  {}", parts.join("  ")));
    }
    if let Some(message) = v["warning"]["message"].as_str() {
        out.push(format!("  ⚠ {}: {message}", s(&v["warning"]["code"])));
        if let Some(hint) = v["warning"]["hint"].as_str() {
            out.push(format!("  → {hint}"));
        }
    }
}

pub fn render(cmd: &str, v: &Value) -> String {
    let mut out = Vec::new();
    if v["ok"] != true {
        out.push(format!(
            "✗ {} ({}): {}",
            s(&v["error"]["code"]),
            s(&v["outcome"]),
            s(&v["error"]["message"])
        ));
        if let Some(h) = v["error"]["hint"].as_str() {
            out.push(format!("  → {h}"));
        }
        if let Some(c) = v["candidates"].as_array() {
            for e in c {
                out.push(format!("  · {}", element_line(e)));
            }
        }
        if let step @ Value::Object(_) = &v["failed_step"] {
            out.push(format!("  step {} ({})", s(&step["index"]), s(&step["kind"])));
        }
        if let call @ Value::Object(_) = &v["failed_call"] {
            out.push(match call["line"].as_u64() {
                Some(line) => format!("  line {line}: {}", s(&call["cmd"])),
                None => format!("  in {}", s(&call["cmd"])),
            });
        }
        if let Some(line) = v["line"].as_u64() {
            out.push(format!("  line {line}"));
        }
        if let Some(sent) = v["inputs_sent"].as_u64().filter(|n| *n > 0) {
            out.push(format!("  {sent} calls had already sent input"));
        }
        if let Some(labels) = v["screen_summary"]["labels"].as_array() {
            let l: Vec<String> = labels.iter().map(s).collect();
            out.push(format!("  on screen: {}", l.join(" · ")));
        }
        type_observation(v, &mut out);
        out.push(format!("  {} ms", s(&v["elapsed_ms"])));
        return out.join("\n");
    }
    match cmd {
        "connect" => {
            out.push(format!("✓ {}  wifi  {}  UDID verified, address saved", s(&v["udid"]), s(&v["ip"])));
            out.push(s(&v["hint"]));
        }
        "read" | "find" => {
            if cmd == "read" {
                let apps: Vec<String> = v["apps"]
                    .as_array()
                    .map(|a| a.iter().map(|x| s(&x["name"])).collect())
                    .unwrap_or_default();
                out.push(format!(
                    "{}  {}x{}  {} elements",
                    apps.join(", "),
                    s(&v["screen"]["width"]),
                    s(&v["screen"]["height"]),
                    s(&v["count"])
                ));
            } else {
                out.push(format!("{} match(es) for {}", s(&v["count"]), s(&v["selector"])));
            }
            for e in v["elements"].as_array().into_iter().flatten() {
                let indent = "  ".repeat(e["depth"].as_u64().unwrap_or(0) as usize);
                out.push(format!("{indent}{}", element_line(e)));
            }
        }
        "diagnose" => {
            out.push(s(&v["report"]));
            for finding in v["findings"].as_array().into_iter().flatten() {
                out.push(format!("  {}", s(finding)));
            }
            out.push(s(&v["hint"]));
        }
        "doctor" => {
            for c in v["checks"].as_array().into_iter().flatten() {
                let mark = match c["status"].as_str() {
                    Some("ok") => "✓",
                    Some("fail") => "✗",
                    Some("warn") => "!",
                    Some("skipped") => "-",
                    _ => "·",
                };
                let req = if c["required"] == true { "required" } else { "recommended" };
                let mut line = format!("{mark} {:<22} {req}", s(&c["check"]));
                if let Some(d) = c["detail"].as_str() {
                    line.push_str(&format!("  ({d})"));
                }
                out.push(line);
                if c["status"] != "ok"
                    && let Some(a) = c["user_action"].as_str() {
                        out.push(format!("    → {a}"));
                    }
            }
            out.push(if v["ready"] == true { "ready".into() } else { "not ready".to_string() });
        }
        "devices" => {
            for d in v["devices"].as_array().into_iter().flatten() {
                out.push(format!(
                    "{}  {}  iOS {}  {}  {}",
                    s(&d["udid"]),
                    s(&d["connection"]),
                    s(&d["ios_version"]),
                    s(&d["model"]),
                    s(&d["state"])
                ));
            }
            if out.is_empty() {
                out.push("no devices".into());
            }
        }
        "apps" => {
            for a in v["apps"].as_array().into_iter().flatten() {
                out.push(format!("{:<44} {}", s(&a["bundle_id"]), s(&a["name"])));
            }
        }
        "scripts" => {
            for r in v["scripts"].as_array().into_iter().flatten() {
                out.push(format!("{:<24} {}  [{}]", s(&r["name"]), s(&r["description"]), s(&r["source"])));
            }
        }
        "script" | "batch" => {
            for line in v["logs"].as_array().into_iter().flatten() {
                out.push(format!("  {}", s(line)));
            }
            for st in v["steps"].as_array().into_iter().flatten() {
                out.push(format!(
                    "✓ {:>2} {:<13} {:>5} ms",
                    s(&st["index"]),
                    s(&st["kind"]),
                    s(&st["elapsed_ms"])
                ));
                if st["kind"] == "type" {
                    type_observation(st, &mut out);
                }
            }
            if let Some(o) = v["outputs"].as_object() {
                for (k, val) in o {
                    out.push(format!("{k} = {}", match val {
                        Value::String(x) => x.clone(),
                        other => serde_json::to_string_pretty(other).unwrap_or_default(),
                    }));
                }
            }
            out.push(format!("{} ms", s(&v["elapsed_ms"])));
        }
        _ => {
            let mut parts = vec!["✓".to_string()];
            for key in ["screen_changed", "foreground", "found", "scrolls", "value", "clipboard_restored", "path", "state", "stopped", "on", "focus", "set_by_iph"] {
                if v.get("value_changed").is_some() && matches!(key, "value" | "screen_changed") {
                    continue;
                }
                if !v[key].is_null() {
                    parts.push(format!("{key}={}", s(&v[key])));
                }
            }
            let e = &v["element"];
            if e.is_object() {
                let name = ["label", "value", "role"].iter().map(|k| s(&e[*k])).find(|n| !n.is_empty()).unwrap_or_default();
                parts.push(format!("element=\"{name}\""));
            }
            parts.push(format!("{} ms", s(&v["elapsed_ms"])));
            out.push(parts.join("  "));
        }
    }
    type_observation(v, &mut out);
    out.join("\n")
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    fn type_warnings_and_unknown_observations_are_visible() {
        let mut value = json!({
            "ok": true, "value_before": "", "value": "", "verified": true,
            "value_changed": false, "screen_changed": false, "submit_sent": false,
            "warning": {"code": "value_unchanged", "message": "value is unchanged", "hint": "check paste permission"},
        });
        let text = render("type", &value);
        assert!(text.contains("value_before=\"\""));
        assert!(text.contains("value_changed=false"));
        assert!(text.contains("value_unchanged: value is unchanged"));
        assert!(text.contains("check paste permission"));
        let mut step = value.clone();
        step["kind"] = json!("type");
        let batch = json!({"ok": true, "steps": [step]});
        assert!(render("batch", &batch).contains("value_unchanged: value is unchanged"));
        value["value"] = Value::Null;
        value["value_changed"] = Value::Null;
        value["screen_changed"] = Value::Null;
        value["verified"] = json!(false);
        let text = render("type", &value);
        assert!(text.contains("value=null"));
        assert!(text.contains("screen_changed=null"));
        value["ok"] = json!(false);
        value["error"] = json!({"code": "type_not_verified", "message": "Return withheld"});
        let text = render("type", &value);
        assert!(text.contains("Return withheld"));
        assert!(text.contains("value_changed=null"));
        assert!(text.contains("value_unchanged: value is unchanged"));
    }

    #[test]
    fn element_without_label() {
        let v = json!({"ok": true, "element": {"role": "search_field", "value": "검색"}, "elapsed_ms": 5});
        assert_eq!(render("tap", &v), "✓  element=\"검색\"  5 ms");
        let v = json!({"ok": false, "error": {"code": "x", "message": "m"}, "failed_step": {}, "failed_call": {}});
        render("script", &v);
    }
}