agentstreamdeck 2.1.1__py3-none-any.whl

ocdeck/runtime/scripts/examples/OpenCode-Cloud.bat

@@ -0,0 +1,8 @@
+@echo off
+setlocal
+REM Uses providers in your normal OpenCode config; pass --model provider/model.
+set "OPENCODE_CONFIG="
+set "OPENCODE_CONFIG_CONTENT="
+set "OPENCODE_CONFIG_DIR="
+call "%~dp0..\Launch-Agent.bat" --profile opencode -- %*
+exit /b %ERRORLEVEL%

ocdeck/runtime/scripts/render-gallery.py

@@ -0,0 +1,94 @@
+"""Regenerate README examples from the actual device renderer (no hardware needed)."""
+from pathlib import Path
+import sys
+sys.path.insert(0, str(Path(__file__).resolve().parents[1]))
+from dataclasses import replace
+from PIL import Image, ImageDraw, ImageFont
+from ocdeck.art import frame
+from ocdeck.appearance import Appearance, THEMES, animation_phase
+
+OUT = Path(__file__).resolve().parents[1] / 'docs' / 'visuals'
+OUT.mkdir(parents=True, exist_ok=True)
+BG = '#101620'
+FONT = ImageFont.load_default(size=16)
+SMALL = ImageFont.load_default(size=12)
+BASE = Appearance(layout='harness', theme='aurora', show_slot=False)
+STATES = ['running','idle','input','unknown','ready','off']
+HARNESSES = ['opencode','claude','copilot','copilot-vscode','gemini','cursor']
+
+
+def panel(title, rows, phase=24):
+    """Each row: name and (state, style, harness, label, caption) examples."""
+    im = Image.new('RGB', (840, 60 + len(rows)*150), BG)
+    d = ImageDraw.Draw(im)
+    d.text((22,18), title, font=FONT, fill='white')
+    for r, (name, examples) in enumerate(rows):
+        y = 60 + r*150
+        d.text((22,y+44), name, font=SMALL, fill='#a9b8cb')
+        for k, (state, style, harness, label, caption) in enumerate(examples):
+            x = 140 + k*114
+            im.paste(frame(state,label,k,phase,100,style,harness,'Review changes'),(x,y))
+            d.text((x+50,y+113),caption,font=SMALL,fill='#c6d2e3',anchor='mt')
+    return im
+
+
+def save(name, title, rows):
+    panel(title,rows).save(OUT / (name+'.png'), optimize=True)
+
+
+def row(style, states=STATES):
+    return [(state,style,HARNESSES[k],'AgentStreamDeck',state.upper()) for k,state in enumerate(states)]
+
+save('layouts','THREE LAYOUTS / the same six states',[(name.title(),row(replace(BASE,layout=name))) for name in ['classic','harness','minimal']])
+save('themes','FIVE PALETTES / consistent state labels',[(name.title(),row(replace(BASE,theme=name))) for name in THEMES])
+save('harnesses','SIX ADAPTERS / one visual language',[('Harness',[( 'running',replace(BASE,primary='harness',secondary='status'),h,'AgentStreamDeck',n) for h,n in zip(HARNESSES,['OpenCode','Claude','Copilot CLI','Copilot VS Code','Gemini','Cursor'])])])
+text_options=[('status','project','State + project'),('project','status','Project + state'),('harness','status','Harness + state'),('detail','project','Detail + project'),('custom','status','Custom + state'),('none','none','Icon only')]
+save('labels','CHOOSE WHAT GOES UNDER THE ICON',[('Text lines', [('running',replace(BASE,primary=p,secondary=s,custom_text='Code review'),'claude','HomeAILab',caption) for p,s,caption in text_options])])
+save('brightness','PER-BUTTON DIMMING / rendered pixels, fixed device backlight',[('Brightness',[('running',replace(BASE,brightness=b),'gemini','AgentStreamDeck',f'{int(b*100)}%') for b in [.15,.3,.45,.6,.8,1]])])
+styles=[replace(BASE,theme='classic',primary='project',secondary='status'),replace(BASE,theme='ocean',primary='custom',custom_text='Code review'),replace(BASE,layout='minimal',theme='accessible'),replace(BASE,theme='aurora',primary='harness'),replace(BASE,theme='mono',effect='steady'),replace(BASE,theme='ocean',brightness=.6)]
+save('mixed','MIX AND MATCH / six independent button styles',[('Per key',[(s,a,h,'HomeAILab',f'KEY {k+1}') for k,(s,a,h) in enumerate(zip(['running','input','idle','running','unknown','idle'],styles,HARNESSES))])])
+# Compact, fixed-palette animated strips keep the README lightweight.
+for name, title, specs in [
+    ('effects','ANIMATION EFFECTS / same state, different motion', [(e,replace(BASE,layout='classic',effect=e,intensity=1),'input') for e in ['breathe','glow','steady']]),
+    ('speeds','PULSE SPEED / slow, standard, fast', [(f'{v}x',replace(BASE,layout='classic',speed=v,intensity=1),'running') for v in [.5,1,2]])]:
+    frames=[]
+    for tick in range(96):
+        im=Image.new('RGB',(510,210),BG); d=ImageDraw.Draw(im)
+        d.text((18,15),title,font=SMALL,fill='white')
+        for k,(caption,a,state) in enumerate(specs):
+            im.paste(frame(state,'AgentStreamDeck',k,animation_phase(tick/24,a),120,a,'claude'),(25+k*165,52))
+            d.text((85+k*165,185),caption,font=SMALL,fill='white',anchor='mt')
+        frames.append(im)
+    palette = frames[0].quantize(colors=64)
+    frames = [im.quantize(palette=palette,dither=Image.Dither.NONE) for im in frames]
+    frames[0].save(OUT/(name+'.gif'),save_all=True,append_images=frames[1:],duration=[40,40,40,40,40,50]*16,loop=0,optimize=True)
+print('\n'.join(f'{p.name}: {p.stat().st_size:,} bytes' for p in sorted(OUT.iterdir())))
+
+# Extended customization examples, also drawn by the shipped renderer.
+from ocdeck.appearance import PRESETS
+save('presets','ONE-COMMAND PRESETS / real harness marks', [('Presets', [
+    ('running',Appearance(**{**options,'alias':'My agent'}),h,'AgentStreamDeck',name.title())
+    for (name,options),h in zip(PRESETS.items(),HARNESSES)])])
+save('details','SMALL DETAILS / make each key recognizable', [
+    ('Badges', [('input',replace(BASE,badge=b),h,'AgentStreamDeck',b.title()) for b,h in zip(['dot','ring','pill'],HARNESSES)]),
+    ('Borders', [('running',replace(BASE,border=b),'gemini','AgentStreamDeck',b.title()) for b in ['solid','double','corners','none']]),
+    ('Backgrounds', [('idle',replace(BASE,background=b),'claude','AgentStreamDeck',b.title()) for b in ['solid','gradient','grid']]),
+    ('Logo size', [('running',replace(BASE,logo_size=b),'cursor','AgentStreamDeck',b.title()) for b in ['small','normal','large']]),
+])
+save('typography','ALIASES AND TYPOGRAPHY / labels that work for you', [
+    ('Alias', [('running',replace(BASE,alias=a,primary='alias',secondary='status'),'claude','AgentStreamDeck',caption) for a,caption in [('Reviewer','Review agent'),('Builder','Build agent'),('Docs','Writing agent')]]),
+    ('Text size', [('running',replace(BASE,text_size=b,alias='Builder'),'copilot','AgentStreamDeck',b.title()) for b in ['small','normal','large']]),
+    ('Alignment', [('idle',replace(BASE,text_align=b,alias='Docs'),'opencode','AgentStreamDeck',b.title()) for b in ['left','center','right']]),
+])
+frames=[]
+for tick in range(96):
+    im=Image.new('RGB',(510,210),BG);d=ImageDraw.Draw(im)
+    d.text((18,15),'TEXT EFFECTS / clipped scrolling and shimmer',font=SMALL,fill='white')
+    for k,effect in enumerate(['none','scroll','shimmer']):
+        a=replace(BASE,alias='Backend review agent',primary='alias',secondary='status',text_effect=effect,intensity=0)
+        im.paste(frame('running','AgentStreamDeck',k,tick,120,a,'claude'),(25+k*165,52))
+        d.text((85+k*165,185),effect.upper(),font=SMALL,fill='white',anchor='mt')
+    frames.append(im)
+palette=frames[0].quantize(colors=96)
+frames=[im.quantize(palette=palette,dither=Image.Dither.NONE) for im in frames]
+frames[0].save(OUT/'text-effects.gif',save_all=True,append_images=frames[1:],duration=[80,80,80,80,80,100]*16,loop=0,optimize=True)

ocdeck/security.py

@@ -0,0 +1,38 @@
+"""Defense in depth for metadata, diagnostics and logs; never collect prompt bodies."""
+
+import re
+from typing import Any
+
+REDACTED = "[REDACTED]"
+KEY = re.compile(r"token|secret|password|passwd|credential|authorization|api.?key|cookie|private.?key", re.I)
+PATTERNS = [
+    re.compile(
+        r"""(?i)(?:[\w.-]*(?:token|secret|password|passwd|credential|api[_-]?key)[\w.-]*)[\s"']*[:=]\s*(?:"[^"\r\n]*"|'[^'\r\n]*')"""
+    ),
+    re.compile(r"-----BEGIN [^-]*PRIVATE KEY-----[\s\S]*?-----END [^-]*PRIVATE KEY-----"),
+    re.compile(r"\b(?:Bearer|Basic)\s+[A-Za-z0-9._~+/=-]+", re.I),
+    re.compile(
+        r"\b(?:sk-[\w-]{8,}|gh[pousr]_[\w]{8,}|github_pat_[\w]{8,}|AKIA[A-Z0-9]{16}|eyJ[\w-]+\.[\w-]+\.[\w-]+)\b"
+    ),
+    re.compile(
+        r"(?i)(?:[\w.-]*(?:token|secret|password|passwd|credential|api[_-]?key)[\w.-]*)[\s\"\']*[:=][\s\"\']*[^\s,;\"\'&}]+"
+    ),
+    re.compile(r"https?://[^\s/@:]+:[^\s/@]+@"),
+]
+
+
+def scrub_text(value: str, secrets: tuple[str, ...] = ()) -> str:
+    for secret in secrets:
+        if secret:
+            value = value.replace(secret, REDACTED)
+    for pattern in PATTERNS:
+        value = pattern.sub(REDACTED, value)
+    return value
+
+
+def scrub(value: Any, secrets: tuple[str, ...] = ()) -> Any:
+    if isinstance(value, dict):
+        return {str(k): REDACTED if KEY.search(str(k)) else scrub(v, secrets) for k, v in value.items()}
+    if isinstance(value, (list, tuple)):
+        return [scrub(v, secrets) for v in value]
+    return scrub_text(value, secrets) if isinstance(value, str) else value

ocdeck/settings.py

@@ -0,0 +1,42 @@
+"""Validate optional broker features before starting background workers."""
+
+import math
+from .appearance_io import export_settings
+
+
+def validate_config(config):
+    if not isinstance(config, dict):
+        raise ValueError("config.json must contain an object")
+    export_settings(config)
+    if type(config.get("slots", 6)) is not int or config.get("slots", 6) not in (6, 15, 32):
+        raise ValueError("slots must be 6, 15 or 32 (mock capacity; physical deck auto-detects)")
+    for name in ("check_updates", "allow_elgato", "animations", "ready"):
+        if name in config and type(config[name]) is not bool:
+            raise ValueError(name + " must be boolean")
+    if type(config.get("brightness", 45)) is not int or not 0 <= config.get("brightness", 45) <= 100:
+        raise ValueError("brightness must be 0..100")
+    alerts = config.get("alerts", {})
+    if not isinstance(alerts, dict) or set(alerts) - {
+        "sound",
+        "toast",
+        "sound_file",
+        "states",
+        "cooldown_seconds",
+        "muted_slots",
+    }:
+        raise ValueError("Unknown or invalid alerts configuration")
+    for name in ("sound", "toast"):
+        if type(alerts.get(name, False)) is not bool:
+            raise ValueError("alerts." + name + " must be boolean")
+    states = alerts.get("states", ["input"])
+    if not isinstance(states, list) or any(x not in ("input", "running", "idle", "unknown") for x in states):
+        raise ValueError("alerts.states must contain input, running, idle or unknown")
+    cooldown = alerts.get("cooldown_seconds", 10)
+    if type(cooldown) not in (int, float) or not math.isfinite(cooldown) or not 0 <= cooldown <= 3600:
+        raise ValueError("alerts.cooldown_seconds must be 0..3600")
+    muted = alerts.get("muted_slots", [])
+    if not isinstance(muted, list) or any(x not in [str(i) for i in range(1, 33)] for x in muted):
+        raise ValueError("alerts.muted_slots must be strings 1..32")
+    if "sound_file" in alerts and not isinstance(alerts["sound_file"], str):
+        raise ValueError("alerts.sound_file must be a WAV file path")
+    return config

ocdeck/uninstall.py

@@ -0,0 +1,100 @@
+"""Receipt-scoped removal; never delete a project or an environment wholesale."""
+
+import json
+import os
+from pathlib import Path
+import shutil
+import subprocess
+import time
+from .common import home, read_json, request
+from .harness import install, PROFILES, SOURCE
+
+
+def discover(roots):
+    found = set()
+    for root in roots:
+        root = Path(root).expanduser().resolve()
+        if not root.is_dir():
+            continue
+        for directory, children, files in os.walk(root, followlinks=False):
+            children[:] = [
+                c
+                for c in children
+                if c not in (".git", "node_modules", ".venv", "venv") and not (Path(directory) / c).is_symlink()
+            ]
+            if Path(directory).name == ".agentdeck":
+                if any(f == p + ".json" for p in PROFILES for f in files):
+                    found.add(str(Path(directory).parent))
+                children[:] = []
+    return sorted(found)
+
+
+def uninstall(scan=(), dry_run=False):
+    root = home().resolve()
+    registered = read_json(root / "projects.json", []) or []
+    projects = sorted(set([*registered, *discover(scan or [Path.cwd()])]))
+    plans = []
+    for project in projects:
+        for profile in PROFILES:
+            if (Path(project) / ".agentdeck" / (profile + ".json")).exists():
+                plans.append((profile, project))
+    print(
+        json.dumps(
+            {
+                "projects": plans,
+                "local": ["scheduled task", "managed OpenCode plugin", "managed shims", "configuration"],
+                "backups": "Retained under " + str(root / "backups"),
+                "dryRun": dry_run,
+            },
+            indent=2,
+        )
+    )
+    # Preflight every receipt before changing anything. The native installer refuses
+    # moved targets, malformed JSON and shell metacharacters in installed paths.
+    for profile, project in plans:
+        if install(profile, project, remove=True, dry_run=True):
+            raise RuntimeError("Hook removal preflight failed; no uninstall changes applied")
+    if dry_run:
+        return 0
+    try:
+        status = request("GET", "/v1/status")
+    except Exception:
+        status = {}
+    if any(v.get("id") for v in status.get("slots", [])) or status.get("overflow"):
+        raise RuntimeError("Close managed agent sessions before uninstalling; run ocdeck status")
+    for profile, project in plans:
+        if install(profile, project, remove=True):
+            raise RuntimeError("Project hook removal failed; local installation retained")
+    metadata = read_json(root / "install.json", {}) or {}
+    if os.name == "nt":
+        script = SOURCE / "scripts" / "Remove-Integration.ps1"
+        subprocess.run(["powershell.exe", "-NoProfile", "-File", str(script), "-Data", str(root)], check=True)
+    try:
+        request("POST", "/v1/stop")
+    except Exception:
+        pass
+    # Give the broker time to release discovery/log files; never move its token live.
+    for _ in range(30):
+        try:
+            request("GET", "/v1/status", timeout=0.2)
+        except Exception:
+            break
+        time.sleep(0.1)
+    else:
+        raise RuntimeError("Broker did not stop; local files retained. Run ocdeck stop")
+    backup = root / "backups" / str(time.time_ns())
+    backup.mkdir(parents=True, exist_ok=False)
+    for name in ("config.json", "install.json", "projects.json", "update.json", "token", "discovery.json"):
+        path = root / name
+        if path.exists():
+            shutil.move(str(path), str(backup / name))
+    # Remove only exact known shims after verifying their runtime/command marker.
+    runtime = metadata.get("python")
+    for name in ("ocdeck.cmd", "oc.cmd", "opencode.cmd"):
+        path = root / "bin" / name
+        if path.exists() and runtime:
+            text = path.read_text(errors="replace")
+            if runtime in text and " -m ocdeck " in text:
+                shutil.move(str(path), str(backup / name))
+    print("Uninstalled managed hooks, integration and configuration. Backups and Python environment retained.")
+    return 0

ocdeck/updates.py

@@ -0,0 +1,46 @@
+"""One bounded, optional release lookup per broker start; never installs software."""
+
+import json
+import logging
+import urllib.request
+from packaging.version import Version, InvalidVersion
+from . import __version__
+from .common import read_json, atomic_json
+from .security import scrub
+
+URL = "https://api.github.com/repos/darkmatter2222/AgentStreamDeck/releases/latest"
+LOG = logging.getLogger(__name__)
+
+
+def check(root, config, fetch=None):
+    if not config.get("check_updates", True):
+        return None
+    try:
+        if fetch is None:
+            req = urllib.request.Request(
+                URL, headers={"User-Agent": "AgentStreamDeck", "Accept": "application/vnd.github+json"}
+            )
+            with urllib.request.urlopen(req, timeout=3) as response:
+                raw = response.read(262145)
+            if len(raw) > 262144:
+                raise ValueError("Release response too large")
+            release = json.loads(raw)
+        else:
+            release = fetch()
+        version = str(release["tag_name"])
+        if release.get("draft") or release.get("prerelease") or Version(version) <= Version(__version__):
+            return None
+        info = {
+            "version": version,
+            "url": "https://github.com/darkmatter2222/AgentStreamDeck/releases",
+            "notes": scrub(str(release.get("body", ""))[:8000]),
+        }
+        state = read_json(root / "update.json", {}) or {}
+        if state.get("version") != version:
+            LOG.info("Update available: %s — %s", version, info["url"])
+            print(f"AgentStreamDeck {version} available: {info['url']}\n{info['notes']}", flush=True)
+            atomic_json(root / "update.json", info)
+        return info
+    except (OSError, ValueError, KeyError, TypeError, InvalidVersion):
+        LOG.info("Update check unavailable; continuing offline")
+        return None