Metadata-Version: 2.4
Name: agentstreamdeck
Version: 3.0.6
Summary: Local AI coding-agent status, alerts and focus for Stream Deck Mini, MK.2 and XL
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://github.com/darkmatter2222/AgentStreamDeck
Project-URL: Documentation, https://github.com/darkmatter2222/AgentStreamDeck#readme
Project-URL: Issues, https://github.com/darkmatter2222/AgentStreamDeck/issues
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: packaging<27,>=24
Requires-Dist: Pillow<13,>=10.4
Requires-Dist: psutil==7.2.2
Requires-Dist: streamdeck==0.10.0
Requires-Dist: hidapi==0.15.0
Provides-Extra: dev
Requires-Dist: ruff==0.12.12; extra == "dev"
Requires-Dist: pyright==1.1.405; extra == "dev"
Requires-Dist: pre-commit<5,>=4; extra == "dev"
Requires-Dist: build<2,>=1; extra == "dev"
Dynamic: license-file

# AgentStreamDeck

**Your AI agents, one glance away.** See which session is working, waiting or needs you—then press a Stream Deck key to jump back in.

<p align="center">
  <img src="docs/jelly/readme_hero.gif" alt="Animated Stream Deck with agent status keys and Jelly exploring unused buttons" width="100%">
</p>

[![Tests](https://github.com/darkmatter2222/AgentStreamDeck/actions/workflows/ci.yml/badge.svg)](https://github.com/darkmatter2222/AgentStreamDeck/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/agentstreamdeck)](https://pypi.org/project/agentstreamdeck/)
[![Python 3.11+](https://img.shields.io/badge/Python-3.11%2B-3776AB)](pyproject.toml)
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue)](LICENSE)

[Get started](#get-started) · [Supported agents](#supported-agents) · [Customize](#make-it-yours) · [Documentation](docs/README.md) · [Watch the demo](https://www.youtube.com/watch?v=NTWLbLbJiO0)

> ☕ Enjoying AgentStreamDeck? [Buy Ryan a Coffee](https://buymeacoffee.com/j6oiubzfnh) to support development, hardware testing and documentation. A [GitHub star](https://github.com/darkmatter2222/AgentStreamDeck) helps other developers find it, too.

## Keep your attention on the work

Running several coding agents means several windows to check. AgentStreamDeck gives each session a physical key with its project label, agent icon and live status.

- **Know where you're needed.** Animated status keys distinguish work in progress, idle sessions and supported input requests.
- **Get back with one press.** Focus the session's Windows window; minimized windows are maximized and brought forward.
- **Keep your usual workflow.** Launch your CLI or editor normally after installing its integration. No special launcher, Elgato plugin or MCP server required.
- **Give spare keys some personality.** Jelly, an offline companion, plays on unused buttons and reacts when you tap him.

The hero above uses the actual renderers on a simulated deck. [The video demo](https://www.youtube.com/watch?v=NTWLbLbJiO0) shows the OpenCode workflow on hardware.

## Get started

### 1. Check your setup

| You'll need | Supported setup |
|---|---|
| Stream Deck | Mini (6 keys), Original/MK.2 (15), or XL (32); one device per broker |
| Python | 3.11 or newer |
| Node.js | 20 or newer for hook adapters |
| Desktop | Windows for USB control and window focus; Linux supports the broker and device rendering, but not desktop focus |

Plug in your deck and **quit the Elgato Stream Deck app from the system tray** so AgentStreamDeck can use it.

### 2. Install and start

```powershell
python -m pip install --upgrade agentstreamdeck
python -m ocdeck install
```

The second command registers and starts the background broker for your user, including startup at login. It also installs the OpenCode plugin if `opencode` is on PATH. No repository checkout is needed. The commands use `python -m` so a missing Scripts folder on PATH won't get in your way.

### 3. Connect your agent

For Claude Code, run this from a project you want to monitor:

```powershell
cd C:\Projects\MyApp
python -m ocdeck harness-install claude
claude
```

For another agent, choose its profile below. Repeat hook installation for each project you want to monitor. Existing unrelated hooks are preserved. **OpenCode uses its global plugin**, so just launch `opencode` after step 2; if it wasn't on PATH during setup, run the install command again once it is.

| Agent | Project hook profile | What it can report |
|---|---|---|
| OpenCode | Global plugin; no project profile needed | Activity, permission requests and structured questions |
| Claude Code | `claude` | Activity, identified questions; permission counts may be unknown |
| Codex CLI | `codex` | Activity and observed approval state; counts unknown |
| GitHub Copilot CLI | `copilot-cli` | Activity only |
| Copilot in VS Code | `copilot-vscode` | Activity only; preview integration |
| Gemini CLI | `gemini` | Activity and recognized permission notifications |
| Cursor CLI | `cursor` | Activity only; Cursor desktop isn't included |

For example, use `python -m ocdeck harness-install codex`, then review and trust the hooks in Codex using `/hooks`. [Agent-specific setup and coverage](docs/HARNESSES.md) explains prerequisites and limitations.

### 4. Try a key

Start an agent in the configured project, send it a task and watch its key change. Press the key to return to that session. Use a separate OS window for each monitored session; several tabs in one terminal window can make focus ambiguous.

```powershell
python -m ocdeck status
```

Need more detail? [Installation guide](docs/PLUGIN-FIRST.md) · [Troubleshooting](docs/TROUBLESHOOTING.md) · [Remote and WSL setups](docs/REMOTE-AND-WSL.md)

## Supported agents

The integrations above share the same deck, but their event coverage differs. These are the default visual signals:

| Key | Meaning |
|---|---|
| Green moving ring | Agent reports work in progress |
| Amber breathing glow | Agent reports idle |
| Red attention indicator | Identified input request or observed approval state |
| Amber `LINK ?` | Connection or state is unknown |

**Activity-only integrations can still look busy while waiting for approval.** A green key doesn't guarantee that no input is needed. Input counts appear only when the integration supplies enough information.

Pressing an agent key requests window focus. It never types a reply or approves a tool. Windows can restrict foreground activation; the status output includes the last focus result for diagnosis.

## Make it yours

Choose recognizable agent logos, project labels, layouts, color palettes and animation styles. Apply a preset across the deck or give individual keys their own look.

![Examples of configurable agent key styles](docs/appearance-preview.gif)

```powershell
python -m ocdeck appearance --preset neon --layout harness
```

Restart the broker after saving appearance changes. You can preview changes before saving, export a favorite look, or turn animation off. Sound alerts and Windows notifications are optional and off by default.

[Appearance gallery and settings](docs/APPEARANCE.md) · [Configuration, alerts and maintenance](docs/CONFIGURATION.md)

## Meet Jelly

Jelly makes a home on your spare buttons. He stretches, dances, naps and changes mood with the rhythm of your coding sessions. Tap him for a wobble, cheer or little “Boop!” His thoughts and personality run offline using session activity metadata, without reading your prompts or source code.

![Jelly reacts to a tap and points toward a steaming coffee cup](docs/jelly/coffee_break.gif)

With **two free keys**, Jelly can point to a steaming coffee cup and ask “Coffee?” at a random interval of **1–3 hours**. The invitation lasts **60 seconds**; pressing the cup opens [Ryan's Buy Me a Coffee page](https://buymeacoffee.com/j6oiubzfnh) and dismisses it. The preview speeds up the wait. Agent controls always take priority.

Prefer a quieter deck? Set `"jelly": {"coffee": false}` to disable coffee invitations or `"jelly": {"enabled": false}` to turn Jelly off. Merge these preferences into your existing configuration and restart the broker.

[Jelly's personality, animations and settings](docs/JELLY.md)

## Stay up to date

When an update is available, Jelly settles down with rainbow colors, a red exclamation point, a green upgrade arrow and **“Update available”** beneath him. He moves at most once every 30 seconds so you can read it.

![Update indicator rendered on 72, 80 and 96 pixel keys](docs/jelly/update_available.gif)

**Press the marked Jelly to install the detected update and restart the broker.** Checking for updates never installs anything by itself. You can also update with:

```powershell
python -m pip install --upgrade agentstreamdeck
```

A running broker with upgrade monitoring automatically restarts after the new package finishes installing. Use the same Python environment as the broker. First-time setup still needs `python -m ocdeck install`; older installations may need one restart to enable monitoring. [Upgrade details and opt-outs](docs/CONFIGURATION.md#pip-upgrades-restart-the-broker-automatically)

[Release notes](https://github.com/darkmatter2222/AgentStreamDeck/releases) · [Upgrading from AgentDeck](docs/RENAMING.md)

## Need a hand?

```powershell
python -m ocdeck doctor --no-device --json
python -m ocdeck report --output agentstreamdeck-report.zip --lines 200
```

Start with the [troubleshooting guide](docs/TROUBLESHOOTING.md). On Windows, configuration and logs live under `%USERPROFILE%\.opencode-deck` unless you've set `OCDECK_HOME`; the main log is `broker.log`. Review diagnostic reports before sharing them in a [GitHub issue](https://github.com/darkmatter2222/AgentStreamDeck/issues).

The controller runs locally. Online update checks can be disabled with `"check_updates": false`. [Configuration and removal instructions](docs/CONFIGURATION.md) cover alerts, startup, backups and uninstalling integrations.

## Build with us

Adapter improvements, bug reports and hardware testing are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, [the architecture](docs/ARCHITECTURE.md) for the internals, and [the documentation index](docs/README.md) for deeper guides.

CI tests Windows and Ubuntu with Python 3.11/3.13, including package installation and upgrade behavior. USB hardware and interactive window focus also need real desktop testing; [verification details](docs/TEST-RESULTS.md) distinguish that from automated coverage.

Licensed under [Apache 2.0](LICENSE). Agent names and logos belong to their respective owners; see [third-party notices](THIRD-PARTY.md).
