@adgine/geo-cli 1.2.8

package/skills/adgine-geo-visibility/scripts/_client.py

@@ -0,0 +1,341 @@
+#!/usr/bin/env python3
+"""Shared HTTP client utilities for geo-skills scripts.
+
+Used by all scripts in this skill. Uses Python stdlib only — no external dependencies.
+
+This file is the canonical source. It must be copied verbatim into every
+adgine-geo-* skill folder's scripts/ directory. The sync linter at
+scripts/sync-skills/sync-skills.sh (in the GEOAgent repo) flags any drift.
+"""
+import os
+import sys
+import json
+import time
+import atexit
+import unicodedata
+import urllib.request as _req
+import urllib.error as _uerr
+import urllib.parse as _up
+
+def _load_dot_env():
+    """Load .env from the repo root (adgine-geo-skills/) into os.environ.
+
+    Resolved relative to this file's location, so it works regardless of the
+    agent's working directory (e.g. Hermes, OpenClaw, or any other runtime).
+    Existing environment variables are never overwritten.
+    """
+    if os.environ.get("GEO_API_KEY"):
+        return
+    # _client.py is at <repo_root>/adgine-geo-<skill>/scripts/_client.py
+    repo_root = os.path.dirname(
+        os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+    )
+    env_path = os.path.join(repo_root, ".env")
+    if not os.path.isfile(env_path):
+        return
+    with open(env_path) as _f:
+        for _line in _f:
+            _line = _line.strip()
+            if not _line or _line.startswith("#") or "=" not in _line:
+                continue
+            _k, _, _v = _line.partition("=")
+            _k = _k.strip()
+            _v = _v.strip()
+            if _k and _k not in os.environ:
+                os.environ[_k] = _v
+
+
+_load_dot_env()
+
+_VERSION_UNCHECKED = object()
+_version_state = _VERSION_UNCHECKED
+
+
+def _repo_root():
+    return os.path.dirname(
+        os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+    )
+
+
+def _load_check_version_module():
+    import importlib.util
+    path = os.path.join(_repo_root(), "scripts", "check_version.py")
+    if not os.path.isfile(path):
+        return None
+    spec = importlib.util.spec_from_file_location("geo_check_version", path)
+    mod = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(mod)
+    return mod
+
+
+def _load_version_state():
+    global _version_state
+    if _version_state is not _VERSION_UNCHECKED:
+        return _version_state
+    _version_state = None
+    try:
+        mod = _load_check_version_module()
+        if mod is not None:
+            _version_state = mod.get_state()
+    except Exception:
+        pass
+    return _version_state
+
+
+def _print_version_notice():
+    """Emit machine + human hints at import if a newer version exists."""
+    state = _load_version_state()
+    if not state or not state.get("update_available"):
+        return
+    cur, lat = state["current"], state["latest"]
+    try:
+        mod = _load_check_version_module()
+        if mod is not None:
+            inline = mod.format_user_inline(state)
+            if inline:
+                sys.stdout.write(inline + "\n\n")
+                sys.stdout.flush()
+    except Exception:
+        pass
+    if state.get("install_type") == "git":
+        msg = (f"adgine-geo-skills {lat} available (current {cur}). "
+               "Tell me: 请帮我更新 adgine-geo-skills 到最新版本")
+    else:
+        msg = (f"adgine-geo-skills {lat} available (current {cur}). "
+               f"Download: {state.get('release_url', '')}")
+    notice = {"update": {"current": cur, "latest": lat, "message": msg}}
+    try:
+        line = f"_notice: {json.dumps(notice, ensure_ascii=False)}\n\n"
+        sys.stdout.write(line)
+        sys.stdout.flush()
+    except Exception:
+        pass
+
+
+def _print_version_footer():
+    """Emit human-readable footer at process exit (WorkBuddy-compatible)."""
+    state = _load_version_state()
+    if not state or not state.get("update_available"):
+        return
+    try:
+        mod = _load_check_version_module()
+        if mod is None:
+            return
+        footer = mod.format_user_footer(state)
+        if footer:
+            sys.stdout.write("\n" + footer + "\n")
+            sys.stdout.flush()
+    except Exception:
+        pass
+
+
+_print_version_notice()
+atexit.register(_print_version_footer)
+
+
+def get_api_config():
+    """Read GEO_API_KEY and GEO_API_BASE_URL from environment.
+
+    Exits with a helpful message if GEO_API_KEY is not set.
+    Returns (key, base_url).
+    """
+    key = os.environ.get("GEO_API_KEY", "")
+    base = os.environ.get("GEO_API_BASE_URL", "https://platform.adgine.ai").rstrip("/")
+    if not key:
+        repo_root = os.path.dirname(
+            os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+        )
+        env_path = os.path.join(repo_root, ".env")
+        example_path = os.path.join(repo_root, ".env.example")
+        setup_path = os.path.join(repo_root, "setup.py")
+        print("ERROR: GEO_API_KEY is not set.")
+        print(f"  Expected location: {env_path}")
+        print()
+        print("  One-shot fix (recommended):")
+        print(f"    python3 {setup_path} <YOUR_KEY>")
+        print()
+        print("  Or set it manually:")
+        if not os.path.isfile(env_path):
+            print(f"    cp {example_path} {env_path}")
+        print(f"    edit {env_path} and set GEO_API_KEY=geo_sk_live_xxx")
+        print()
+        print("  Get your key at: https://platform.adgine.ai")
+        print("  The .env file is gitignored — your key stays local and private.")
+        print()
+        print("  NOTE: adgine-geo-site-audit does NOT require an API key.")
+        print("    Run directly: python3 adgine-geo-site-audit/scripts/geo_collect.py <url>")
+        sys.exit(1)
+    return key, base
+
+
+def get_project_id(arg_value=None):
+    """Resolve project ID from argument or GEO_PROJECT_ID env var.
+
+    Exits with instructions if neither is set.
+    """
+    pid = arg_value or os.environ.get("GEO_PROJECT_ID", "")
+    if not pid:
+        print("ERROR: Project ID is required but not set.")
+        print("  Option 1: export GEO_PROJECT_ID=<project-id>")
+        print("  Option 2: pass --project-id <id> to this script")
+        print("  Run list_projects.py from the adgine-geo-projects skill to see your available projects.")
+        sys.exit(1)
+    return pid
+
+
+def _do_request(method, url, key, body=None, timeout=30):
+    """Execute an HTTP request and return parsed JSON.
+
+    Exits with an error message on HTTP errors or network failures.
+    """
+    data = json.dumps(body).encode("utf-8") if body is not None else None
+    headers = {
+        "Authorization": f"Bearer {key}",
+        "Content-Type": "application/json",
+        "Accept": "application/json",
+        "User-Agent": "geo-skills/1.0",
+    }
+    request = _req.Request(url, data=data, headers=headers, method=method)
+    try:
+        with _req.urlopen(request, timeout=timeout) as resp:
+            raw = resp.read().decode("utf-8")
+            return json.loads(raw) if raw else {}
+    except _uerr.HTTPError as e:
+        raw = e.read().decode("utf-8")[:400]
+        try:
+            err_data = json.loads(raw)
+            msg = err_data.get("message") or err_data.get("detail") or raw
+        except Exception:
+            msg = raw
+        if e.code == 401:
+            print("ERROR: Unauthorized — API key is invalid or revoked.")
+            print("  Generate a new key: https://platform.adgine.ai")
+        elif e.code == 403:
+            print("ERROR: Forbidden — insufficient permissions for this operation.")
+        elif e.code == 404:
+            print(f"ERROR: Not found — {msg}")
+        else:
+            print(f"ERROR: HTTP {e.code} — {msg}")
+        sys.exit(1)
+    except Exception as e:
+        print(f"ERROR: Request failed — {e}")
+        sys.exit(1)
+
+
+def api_get(path, key, base, params=None, timeout=30):
+    url = f"{base}{path}"
+    if params:
+        clean = {k: str(v) for k, v in params.items() if v is not None}
+        if clean:
+            url += "?" + _up.urlencode(clean)
+    return _do_request("GET", url, key, timeout=timeout)
+
+
+def api_post(path, key, base, body=None, timeout=30):
+    return _do_request("POST", f"{base}{path}", key, body, timeout=timeout)
+
+
+def api_patch(path, key, base, body=None, timeout=30):
+    return _do_request("PATCH", f"{base}{path}", key, body, timeout=timeout)
+
+
+def api_put(path, key, base, body=None, timeout=30):
+    return _do_request("PUT", f"{base}{path}", key, body, timeout=timeout)
+
+
+def api_delete(path, key, base, timeout=30):
+    return _do_request("DELETE", f"{base}{path}", key, timeout=timeout)
+
+
+def extract_data(result):
+    """Extract the .data field from a standard geo-api envelope response.
+
+    On success the API returns {"code": 0, "data": <payload>, "message": "ok"}.
+    On non-zero code, this prints the message and exits(1).
+    """
+    if not isinstance(result, dict):
+        return result
+    if "code" in result and result.get("code") not in (0, None):
+        msg = result.get("message") or result.get("detail") or "request failed"
+        print(f"ERROR: API returned code={result.get('code')} — {msg}")
+        sys.exit(1)
+    return result.get("data", result)
+
+
+def poll_job(status_path, key, base, interval=3, max_wait=300,
+             terminal=("completed", "failed", "done", "success", "error")):
+    """Poll a job/task endpoint until it reaches a terminal state.
+
+    Prints an inline spinner with the current phase. Returns the final job dict.
+    """
+    elapsed = 0
+    frames = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]
+    idx = 0
+    last_job = {}
+    while elapsed < max_wait:
+        result = api_get(status_path, key, base)
+        last_job = extract_data(result) or {}
+        status = (last_job.get("status") or "").lower()
+        phase = last_job.get("current_phase") or last_job.get("phase") or status or "pending"
+        print(f"\r  {frames[idx % len(frames)]} {phase}... ({elapsed}s)", end="", flush=True)
+        idx += 1
+        if status in terminal:
+            print()  # newline after spinner
+            return last_job
+        time.sleep(interval)
+        elapsed += interval
+    print()
+    print(f"WARNING: Job is still running after {max_wait}s. Check status manually.")
+    return last_job
+
+
+def print_json(data):
+    """Print data as formatted JSON (UTF-8 safe)."""
+    print(json.dumps(data, ensure_ascii=False, indent=2))
+
+
+def fmt_change(value):
+    """Format a numeric change indicator per CONVENTIONS.md §4.
+
+    Returns: '+N' / '-N' / '0' / '--' (None becomes '--').
+    """
+    if value is None:
+        return "--"
+    try:
+        n = float(value)
+    except (TypeError, ValueError):
+        return "--"
+    if n == 0:
+        return "0"
+    sign = "+" if n > 0 else ""
+    if n == int(n):
+        return f"{sign}{int(n):,}"
+    return f"{sign}{n:,.1f}"
+
+
+def truncate(text, n=60, ellipsis="…"):
+    """Truncate text to n characters, adding ellipsis if cut. ASCII-safe for tables."""
+    if text is None:
+        return "--"
+    s = str(text)
+    if len(s) <= n:
+        return s
+    return s[: max(0, n - len(ellipsis))] + ellipsis
+
+def display_width(s):
+    """Return the display width of a string (CJK chars count as 2 columns)."""
+    w = 0
+    for c in str(s):
+        eaw = unicodedata.east_asian_width(c)
+        w += 2 if eaw in ('W', 'F') else 1
+    return w
+
+
+def pad(s, width, align='left'):
+    """Pad string to display width for CJK-aware table alignment.
+    Replaces f'{s:<N}' (align='left') and f'{s:>N}' (align='right').
+    """
+    s = str(s)
+    dw = display_width(s)
+    spaces = max(0, width - dw) * ' '
+    return spaces + s if align == 'right' else s + spaces

package/skills/adgine-geo-visibility/scripts/get_execution.py

@@ -0,0 +1,151 @@
+#!/usr/bin/env python3
+"""Prompt execution history & full single-execution detail.
+
+Subcommands:
+  list   --prompt-id <id>                    — recent executions of this prompt
+        [--platform <code>] [--start <>] [--end <>]
+        [--limit 20]
+  get    --prompt-id <id> --execution-id <eid>  — full AI response, brand
+                                                  mentions (rank/sentiment),
+                                                  citations & matches
+
+Usage:
+  python3 scripts/get_execution.py list --prompt-id <pid>
+  python3 scripts/get_execution.py list --prompt-id <pid> --platform openai
+  python3 scripts/get_execution.py get --prompt-id <pid> --execution-id <eid>
+"""
+import sys
+import os
+import argparse
+
+sys.path.insert(0, os.path.dirname(__file__))
+from _client import (
+    get_api_config, get_project_id,
+    api_get,
+    extract_data, print_json, truncate,
+    pad,
+)
+
+
+def cmd_list(args, key, base, pid):
+    params = {"limit": args.limit}
+    if args.platform:
+        params["platform"] = args.platform
+    if args.start:
+        params["start_date"] = args.start
+    if args.end:
+        params["end_date"] = args.end
+
+    result = api_get(
+        f"/api/projects/{pid}/analytics/prompts/{args.prompt_id}/executions",
+        key, base, params=params,
+    )
+    data = extract_data(result)
+    items = data if isinstance(data, list) else (data or {}).get("executions", [])
+
+    if args.json:
+        print_json(items)
+        return
+
+    if not items:
+        print(f"No executions for prompt {args.prompt_id} in this window.")
+        return
+
+    print(f"Executions for prompt {args.prompt_id} ({len(items)})")
+    print()
+    print("```")
+    print("┌──────────────────────────────────────┬────────────┬────────────┬────────────┐")
+    print("│ Execution ID                         │ Platform   │ Date       │ Brand?     │")
+    print("├──────────────────────────────────────┼────────────┼────────────┼────────────┤")
+    for e in items:
+        eid = truncate(e.get("id") or e.get("execution_id"), 36)
+        plat = truncate(e.get("platform") or "--", 10)
+        date = truncate((e.get("executed_at") or e.get("created_at") or "--")[:10], 10)
+        mentioned = e.get("brand_mentioned")
+        if mentioned is None:
+            mentioned = bool(e.get("brand_mentions") or e.get("self_mentioned"))
+        bm = "Yes" if mentioned else "No"
+        print(f"│ {pad(eid, 36)} │ {pad(plat, 10)} │ {pad(date, 10)} │ {pad(bm, 10)} │")
+    print("└──────────────────────────────────────┴────────────┴────────────┴────────────┘")
+    print("```")
+
+
+def cmd_get(args, key, base, pid):
+    result = api_get(
+        f"/api/projects/{pid}/analytics/prompts/{args.prompt_id}/executions/{args.execution_id}",
+        key, base,
+    )
+    data = extract_data(result) or {}
+
+    if args.json:
+        print_json(data)
+        return
+
+    print(f"Execution {args.execution_id}")
+    print(f"  prompt:    {args.prompt_id}")
+    print(f"  platform:  {data.get('platform')}")
+    print(f"  date:      {(data.get('executed_at') or data.get('created_at') or '')[:19]}")
+    print()
+    response = data.get("response") or data.get("ai_response") or data.get("answer")
+    if response:
+        print("AI Response:")
+        print("---")
+        print(response)
+        print("---")
+        print()
+
+    mentions = data.get("brand_mentions") or data.get("mentions") or []
+    if mentions:
+        print(f"Brand mentions ({len(mentions)}):")
+        print()
+        print("```")
+        print("┌──────────────────────────────┬────────┬────────────┬────────────┐")
+        print("│ Brand                        │  Rank  │ Sentiment  │ Is yours?  │")
+        print("├──────────────────────────────┼────────┼────────────┼────────────┤")
+        for m in mentions:
+            name = truncate(m.get("brand") or m.get("name"), 28)
+            rank = m.get("rank") or m.get("position") or "--"
+            sent = truncate(m.get("sentiment") or "--", 10)
+            mine = "Yes" if (m.get("is_self") or m.get("self")) else "No"
+            print(f"│ {pad(name, 28)} │ {str(rank):>6} │ {pad(sent, 10)} │ {pad(mine, 10)} │")
+        print("└──────────────────────────────┴────────┴────────────┴────────────┘")
+        print("```")
+        print()
+
+    citations = data.get("citations") or data.get("links") or []
+    if citations:
+        print(f"Citations ({len(citations)}):")
+        for c in citations[:10]:
+            url = c.get("url") or c.get("link")
+            title = truncate(c.get("title") or "", 60)
+            print(f"  • {title}")
+            print(f"    {url}")
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Prompt execution history & detail")
+    parser.add_argument("--project-id", help="Project ID (or set GEO_PROJECT_ID env var)")
+    parser.add_argument("--json", action="store_true", help="Output raw JSON")
+    sub = parser.add_subparsers(dest="command", required=True)
+
+    p_l = sub.add_parser("list", help="List recent executions")
+    p_l.add_argument("--prompt-id", required=True)
+    p_l.add_argument("--platform", choices=["openai", "google_aio", "perplexity", "gemini"])
+    p_l.add_argument("--start", help="Start date YYYY-MM-DD")
+    p_l.add_argument("--end", help="End date YYYY-MM-DD")
+    p_l.add_argument("--limit", type=int, default=20)
+
+    p_g = sub.add_parser("get", help="Full execution detail")
+    p_g.add_argument("--prompt-id", required=True)
+    p_g.add_argument("--execution-id", required=True)
+
+    args = parser.parse_args()
+    key, base = get_api_config()
+    pid = get_project_id(args.project_id)
+
+    handlers = {"list": cmd_list, "get": cmd_get}
+    handlers[args.command](args, key, base, pid)
+
+
+if __name__ == "__main__":
+    main()

package/skills/adgine-geo-visibility/scripts/get_matrix.py

@@ -0,0 +1,111 @@
+#!/usr/bin/env python3
+"""Competitor × AI-platform matrix (Visibility Score or Share of Voice).
+
+Shows a grid of competitor brands (rows) × AI platforms (cols), with the
+chosen metric in each cell. Useful for "我的品牌在 ChatGPT/Perplexity 上
+跟竞争对手相比怎么样" / "竞品矩阵".
+
+Options:
+  --metric visibility|sov           — which metric to plot (default: visibility)
+  --start <YYYY-MM-DD>  --end <>    time window
+
+Usage:
+  python3 scripts/get_matrix.py
+  python3 scripts/get_matrix.py --metric sov --start 2025-11-01
+"""
+import sys
+import os
+import argparse
+
+sys.path.insert(0, os.path.dirname(__file__))
+from _client import (
+    get_api_config, get_project_id,
+    api_get,
+    extract_data, print_json, truncate,
+)
+
+
+def _fmt(v):
+    if v is None:
+        return "--"
+    try:
+        return f"{float(v):.1f}"
+    except (TypeError, ValueError):
+        return str(v)[:6]
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Competitor × AI-platform matrix")
+    parser.add_argument("--project-id", help="Project ID (or set GEO_PROJECT_ID env var)")
+    parser.add_argument("--metric", choices=["visibility", "sov"], default="visibility")
+    parser.add_argument("--start", help="Start date YYYY-MM-DD")
+    parser.add_argument("--end", help="End date YYYY-MM-DD")
+    parser.add_argument("--json", action="store_true", help="Output raw JSON")
+    args = parser.parse_args()
+
+    key, base = get_api_config()
+    pid = get_project_id(args.project_id)
+
+    # API expects "share_of_voice" not "sov"
+    metric_param = "share_of_voice" if args.metric == "sov" else args.metric
+    params = {"metric": metric_param}
+    if args.start:
+        params["start_date"] = args.start
+    if args.end:
+        params["end_date"] = args.end
+
+    result = api_get(
+        f"/api/projects/{pid}/analytics/platforms/matrix",
+        key, base, params=params,
+    )
+    data = extract_data(result) or {}
+
+    if args.json:
+        print_json(data)
+        return
+
+    platforms = data.get("platforms") or data.get("columns") or []
+    rows = data.get("rows") or data.get("brands") or data.get("competitors") or []
+
+    if not rows or not platforms:
+        print("No matrix data available.")
+        return
+
+    label = "Visibility Score (%)" if args.metric == "visibility" else "Share of Voice (%)"
+    print(f"Competitor × Platform Matrix — {label}")
+    print()
+    print("```")
+    # Header
+    head = "│ {:<20} │".format("Brand")
+    sep_top = "┌" + "─" * 22 + "┬"
+    sep_mid = "├" + "─" * 22 + "┼"
+    sep_bot = "└" + "─" * 22 + "┴"
+    for p in platforms:
+        name = truncate(p.get("name") or p.get("code") or str(p), 8)
+        head += " {:>8} │".format(name)
+        sep_top += "─" * 10 + "┬"
+        sep_mid += "─" * 10 + "┼"
+        sep_bot += "─" * 10 + "┴"
+    print(sep_top[:-1] + "┐")
+    print(head)
+    print(sep_mid[:-1] + "┤")
+    for r in rows:
+        bname = truncate(r.get("brand") or r.get("name") or "?", 20)
+        is_self = r.get("is_self") or r.get("self")
+        prefix = "★ " if is_self else "  "
+        row = "│ {:<20} │".format(prefix + bname)[:24]  # safety
+        row = "│ {:<20} │".format(prefix + bname)
+        values = r.get("values") or r.get("scores") or {}
+        for p in platforms:
+            code = p.get("code") or p.get("name") or str(p)
+            v = values.get(code) if isinstance(values, dict) else None
+            row += " {:>8} │".format(_fmt(v))
+        print(row)
+    print(sep_bot[:-1] + "┘")
+    print("```")
+    print()
+    print("★ = your brand")
+
+
+if __name__ == "__main__":
+    main()