agenthud 0.1.5__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. agenthud-0.1.5/.gitignore +20 -0
  2. agenthud-0.1.5/CODE_OF_CONDUCT.md +133 -0
  3. agenthud-0.1.5/CONTRIBUTING.md +92 -0
  4. agenthud-0.1.5/LICENSE +21 -0
  5. agenthud-0.1.5/PKG-INFO +184 -0
  6. agenthud-0.1.5/README.md +156 -0
  7. agenthud-0.1.5/docs/media/demo.gif +0 -0
  8. agenthud-0.1.5/docs/media/popover-opencode.png +0 -0
  9. agenthud-0.1.5/docs/media/popover.png +0 -0
  10. agenthud-0.1.5/docs/media/settings.png +0 -0
  11. agenthud-0.1.5/pyproject.toml +60 -0
  12. agenthud-0.1.5/src/agenthud/__init__.py +3 -0
  13. agenthud-0.1.5/src/agenthud/__main__.py +4 -0
  14. agenthud-0.1.5/src/agenthud/adapters/__init__.py +1 -0
  15. agenthud-0.1.5/src/agenthud/adapters/claude.py +108 -0
  16. agenthud-0.1.5/src/agenthud/adapters/codex.py +127 -0
  17. agenthud-0.1.5/src/agenthud/adapters/cursor.py +158 -0
  18. agenthud-0.1.5/src/agenthud/adapters/freebuff.py +147 -0
  19. agenthud-0.1.5/src/agenthud/adapters/opencode.py +97 -0
  20. agenthud-0.1.5/src/agenthud/adapters/stub.py +9 -0
  21. agenthud-0.1.5/src/agenthud/aggregate.py +37 -0
  22. agenthud-0.1.5/src/agenthud/assets/popover.html +492 -0
  23. agenthud-0.1.5/src/agenthud/assets/settings.html +285 -0
  24. agenthud-0.1.5/src/agenthud/cli.py +102 -0
  25. agenthud-0.1.5/src/agenthud/focus.py +105 -0
  26. agenthud-0.1.5/src/agenthud/install.py +201 -0
  27. agenthud-0.1.5/src/agenthud/menubar.py +8 -0
  28. agenthud-0.1.5/src/agenthud/models.py +59 -0
  29. agenthud-0.1.5/src/agenthud/native_menubar.py +599 -0
  30. agenthud-0.1.5/src/agenthud/paths.py +36 -0
  31. agenthud-0.1.5/src/agenthud/registry.py +105 -0
  32. agenthud-0.1.5/src/agenthud/settings.py +104 -0
  33. agenthud-0.1.5/src/agenthud/tui.py +119 -0
@@ -0,0 +1,20 @@
1
+ .venv/
2
+ __pycache__/
3
+ *.egg-info/
4
+ dist/
5
+ dist/.cache/
6
+ build/
7
+ *.app/
8
+ .pytest_cache/
9
+ .ruff_cache/
10
+ .DS_Store
11
+ .agents/
12
+ .cursor/
13
+ skills-lock.json
14
+ *.db
15
+ *.db-shm
16
+ *.db-wal
17
+ .env
18
+ .env.*
19
+ credentials.json
20
+ **/state.json
@@ -0,0 +1,133 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, caste, color, religion, or sexual
10
+ identity and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the overall
26
+ community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or advances of
31
+ any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email address,
35
+ without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official email address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at the contact
63
+ listed in the repository (GitHub maintainer profile / security contact).
64
+
65
+ All complaints will be reviewed and investigated promptly and fairly.
66
+
67
+ All community leaders are obligated to respect the privacy and security of the
68
+ reporter of any incident.
69
+
70
+ ## Enforcement Guidelines
71
+
72
+ Community leaders will follow these Community Impact Guidelines in determining
73
+ the consequences for any action they deem in violation of this Code of Conduct:
74
+
75
+ ### 1. Correction
76
+
77
+ **Community Impact**: Use of inappropriate language or other behavior deemed
78
+ unprofessional or unwelcome in the community.
79
+
80
+ **Consequence**: A private, written warning from community leaders, providing
81
+ clarity around the nature of the violation and an explanation of why the
82
+ behavior was inappropriate. A public apology may be requested.
83
+
84
+ ### 2. Warning
85
+
86
+ **Community Impact**: A violation through a single incident or series of
87
+ actions.
88
+
89
+ **Consequence**: A warning with consequences for continued behavior. No
90
+ interaction with the people involved, including unsolicited interaction with
91
+ those enforcing the Code of Conduct, for a specified period of time. This
92
+ includes avoiding interactions in community spaces as well as external channels
93
+ like social media. Violating these terms may lead to a temporary or permanent
94
+ ban.
95
+
96
+ ### 3. Temporary Ban
97
+
98
+ **Community Impact**: A serious violation of community standards, including
99
+ sustained inappropriate behavior.
100
+
101
+ **Consequence**: A temporary ban from any sort of interaction or public
102
+ communication with the community for a specified period of time. No public or
103
+ private interaction with the people involved, including unsolicited interaction
104
+ with those enforcing the Code of Conduct, is allowed during this period.
105
+ Violating these terms may lead to a permanent ban.
106
+
107
+ ### 4. Permanent Ban
108
+
109
+ **Community Impact**: Demonstrating a pattern of violation of community
110
+ standards, including sustained inappropriate behavior, harassment of an
111
+ individual, or aggression toward or disparagement of classes of individuals.
112
+
113
+ **Consequence**: A permanent ban from any sort of public interaction within the
114
+ community.
115
+
116
+ ## Attribution
117
+
118
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119
+ version 2.1, available at
120
+ [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121
+
122
+ Community Impact Guidelines were inspired by
123
+ [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124
+
125
+ For answers to common questions about this code of conduct, see the FAQ at
126
+ [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127
+ [https://www.contributor-covenant.org/translations][translations].
128
+
129
+ [homepage]: https://www.contributor-covenant.org
130
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131
+ [Mozilla CoC]: https://github.com/mozilla/diversity
132
+ [FAQ]: https://www.contributor-covenant.org/faq
133
+ [translations]: https://www.contributor-covenant.org/translations
@@ -0,0 +1,92 @@
1
+ # Contributing to agenthud
2
+
3
+ Thanks for helping. This project stays small on purpose: a local, read-only HUD over coding-agent sessions.
4
+
5
+ ## Code of Conduct
6
+
7
+ By participating, you agree to the [Code of Conduct](CODE_OF_CONDUCT.md).
8
+
9
+ ## Ways to contribute
10
+
11
+ - **Bug reports** — OS version, Python version, which agent, steps to reproduce
12
+ - **New agent adapters** — read-only collectors under `src/agenthud/adapters/`
13
+ - **Detection / install recipes** — `registry.py`, `install.py`
14
+ - **UI polish** — `assets/popover.html`, `assets/settings.html` (prefer system fonts, accessibility, no telemetry)
15
+ - **Docs** — README clarity, examples
16
+
17
+ ## Development setup
18
+
19
+ ```bash
20
+ git clone https://github.com/scs0209/agenthud.git
21
+ cd agenthud
22
+ python3 -m venv .venv
23
+ source .venv/bin/activate # Windows: .venv\Scripts\activate
24
+ pip install -e .
25
+ agenthud --once # smoke test without menu bar
26
+ agenthud menubar # macOS only
27
+ ```
28
+
29
+ Python **3.11+** required. Menu bar needs macOS + PyObjC.
30
+
31
+ ## Project layout
32
+
33
+ | Path | Role |
34
+ |------|------|
35
+ | `src/agenthud/adapters/` | One module per agent; `collect(...)` → `list[Session]` |
36
+ | `src/agenthud/registry.py` | Agent metadata + “installed?” detection |
37
+ | `src/agenthud/install.py` | Install recipes (Terminal command or URL) |
38
+ | `src/agenthud/models.py` | `Tool`, `Status`, `Session` |
39
+ | `src/agenthud/native_menubar.py` | macOS status item + WKWebView |
40
+ | `src/agenthud/assets/` | Popover / Settings HTML |
41
+
42
+ ## Adding an agent adapter
43
+
44
+ 1. Add a `Tool` enum value in `models.py` if needed.
45
+ 2. Register the agent in `registry.py` (`AgentInfo` + detect paths).
46
+ 3. Add an install recipe in `install.py` when a public install path exists.
47
+ 4. Implement `adapters/<name>.py` with:
48
+
49
+ ```python
50
+ def collect(*, limit: int = 40, max_age_hours: float = 72) -> list[Session]:
51
+ ...
52
+ ```
53
+
54
+ 5. Wire it in `aggregate.py` `_COLLECTORS`.
55
+ 6. Keep collectors **read-only**. Never write agent DBs or print secrets.
56
+ 7. Run `agenthud --json --tools <id>` and confirm rows look right.
57
+
58
+ ## Pull requests
59
+
60
+ 1. Fork and create a branch from `main`.
61
+ 2. Keep diffs focused — one concern per PR when possible.
62
+ 3. Do not commit `.venv/`, personal `settings.json`, or agent transcripts.
63
+ 4. Update README tables if you add/change an agent.
64
+ 5. Open a PR with:
65
+ - **What** changed
66
+ - **Why**
67
+ - How you tested (`agenthud --once`, menubar click path, etc.)
68
+
69
+ ### Commit messages
70
+
71
+ Use **English only** for commit subjects/bodies and pull request titles/descriptions.
72
+
73
+ Prefer short, imperative subjects:
74
+
75
+ - `feat: add Gemini CLI session adapter`
76
+ - `fix: disable settings toggle when agent not installed`
77
+ - `docs: clarify local-only privacy model`
78
+
79
+ ## Code style
80
+
81
+ - Match surrounding code (typing, dataclasses, no drive-by refactors).
82
+ - Avoid new dependencies unless necessary; prefer stdlib + existing stack (`rich`, PyObjC on Darwin).
83
+ - UI: respect `prefers-reduced-motion` / `prefers-reduced-transparency` when touching HTML/CSS.
84
+
85
+ ## Issues
86
+
87
+ - Search existing issues first.
88
+ - Include redacted paths if needed — never paste API keys, cookies, or full Freebuff `state.json`.
89
+
90
+ ## License
91
+
92
+ Contributions are licensed under the [MIT License](LICENSE).
agenthud-0.1.5/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 ayaan
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,184 @@
1
+ Metadata-Version: 2.5
2
+ Name: agenthud
3
+ Version: 0.1.5
4
+ Summary: Cross-tool agent session HUD for Cursor, OpenCode, Freebuff, Codex, and more
5
+ Project-URL: Homepage, https://github.com/scs0209/agenthud
6
+ Project-URL: Repository, https://github.com/scs0209/agenthud
7
+ Project-URL: Issues, https://github.com/scs0209/agenthud/issues
8
+ Project-URL: Release, https://github.com/scs0209/agenthud/releases
9
+ Author-email: ayaan <scs0209@users.noreply.github.com>
10
+ License: MIT
11
+ License-File: LICENSE
12
+ Keywords: agents,claude,cli,codex,cursor,freebuff,hud,menubar,opencode
13
+ Classifier: Development Status :: 4 - Beta
14
+ Classifier: Environment :: Console
15
+ Classifier: Environment :: MacOS X
16
+ Classifier: License :: OSI Approved :: MIT License
17
+ Classifier: Operating System :: MacOS
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Classifier: Topic :: Utilities
23
+ Requires-Python: >=3.11
24
+ Requires-Dist: pyobjc-framework-cocoa>=10; sys_platform == 'darwin'
25
+ Requires-Dist: pyobjc-framework-webkit>=10; sys_platform == 'darwin'
26
+ Requires-Dist: rich>=13.0
27
+ Description-Content-Type: text/markdown
28
+
29
+ # agenthud
30
+
31
+ **Cross-tool agent session HUD for macOS.**
32
+
33
+ See every coding agent at a glance — Cursor, OpenCode, Freebuff, Codex, Claude Code, and more — without alt-tabbing through ten windows.
34
+
35
+ agenthud reads **local session data only** (no cloud login, no usage quotas). It answers: *who is waiting on me, who is running, who errored?*
36
+
37
+ <p align="center">
38
+ <img src="docs/media/demo.gif" alt="agenthud demo — popover tabs and settings" width="420" />
39
+ </p>
40
+
41
+ <p align="center">
42
+ <img src="docs/media/popover.png" alt="agenthud menu bar popover" width="320" />
43
+ &nbsp;
44
+ <img src="docs/media/settings.png" alt="agenthud settings" width="280" />
45
+ </p>
46
+
47
+ > Not affiliated with Cursor, OpenAI, Anthropic, or any agent vendor.
48
+
49
+ ## Why
50
+
51
+ Running multiple agents in parallel is normal now. Finding the one that needs approval is not. agenthud puts a small menu-bar badge and a popover over your local sessions so you can jump straight to the right tool.
52
+
53
+ ## Features
54
+
55
+ - **Menu bar HUD** — status badge (`●` waiting / `✖` error / `▶` running) + popover
56
+ - **Per-agent tabs** — only the agent you select
57
+ - **Auto-detect** — on first launch, enables tools that look installed on this Mac
58
+ - **Settings** — enable/disable agents; **Install** for missing ones (Terminal or download page)
59
+ - **Click to focus** — open the matching app / project when possible
60
+ - **TUI + JSON** — `agenthud`, `agenthud --once`, `agenthud --json`
61
+ - **Privacy-first** — read-only local files; never prints tokens
62
+
63
+ ## Requirements
64
+
65
+ - Python **3.11+**
66
+ - **macOS** for the menu bar UI (PyObjC + WebKit)
67
+ - Linux/macOS terminal TUI works with `rich` only
68
+
69
+ ## Install
70
+
71
+ ### Homebrew (macOS app — recommended)
72
+
73
+ ```bash
74
+ brew trust scs0209/agenthud
75
+ brew install --cask scs0209/agenthud/agenthud
76
+ ```
77
+
78
+ Then open **AgentHUD**, or run `agenthud menubar`.
79
+
80
+ Upgrade: `brew upgrade --cask agenthud`
81
+
82
+ CLI-only (no `.app`):
83
+
84
+ ```bash
85
+ brew trust scs0209/agenthud
86
+ brew install scs0209/agenthud/agenthud
87
+ ```
88
+
89
+ ### pip
90
+
91
+ ```bash
92
+ pip install https://github.com/scs0209/agenthud/releases/download/v0.1.5/agenthud-0.1.5-py3-none-any.whl
93
+ ```
94
+
95
+ PyPI (`pip install agenthud`) is wired via GitHub Actions trusted publishing — publish completes once a PyPI project + trusted publisher (or `PYPI_API_TOKEN` secret) is connected.
96
+
97
+ ### From source
98
+
99
+ ```bash
100
+ git clone https://github.com/scs0209/agenthud.git
101
+ cd agenthud
102
+ python3 -m venv .venv
103
+ source .venv/bin/activate
104
+ pip install -e .
105
+ ```
106
+
107
+ > First launch may show a Gatekeeper prompt (ad-hoc signed). Prefer right-click → **Open**, or:
108
+ > `xattr -dr com.apple.quarantine /Applications/AgentHUD.app`
109
+ >
110
+ > **macOS 26 (Tahoe):** if the app launches but you see nothing, open
111
+ > **System Settings → Menu Bar** and enable **AgentHUD** under
112
+ > “Allow in the Menu Bar” (not leftover `python3.13` entries from older builds).
113
+ > agenthud will also show a guidance dialog when it detects a hidden icon.
114
+ ## Usage
115
+
116
+ ```bash
117
+ agenthud menubar # macOS menu bar (recommended)
118
+ agenthud # terminal live TUI
119
+ agenthud --once # one snapshot
120
+ agenthud --json # machine-readable
121
+ agenthud --tools cursor,codex
122
+ agenthud --max-age-hours 24
123
+ ```
124
+
125
+ Prefs: `~/.config/agenthud/settings.json`
126
+
127
+ ### Environment overrides
128
+
129
+ | Variable | Default |
130
+ |----------|---------|
131
+ | `AGENTHUD_CURSOR_PROJECTS` | `~/.cursor/projects` |
132
+ | `AGENTHUD_OPENCODE_DB` | `~/.local/share/opencode/opencode.db` |
133
+ | `AGENTHUD_FREEBUFF_DIR` | `~/.config/freebuff-desktop` |
134
+
135
+ ## Status legend
136
+
137
+ | Status | Meaning |
138
+ |--------|---------|
139
+ | `waiting` | Needs you |
140
+ | `running` | Recent activity / turn in flight |
141
+ | `error` | Last turn failed |
142
+ | `idle` | Quiet |
143
+ | `done` | Finished / stale |
144
+
145
+ Statuses are **best-effort heuristics** from local logs/DBs. Agents without a live status API are inferred from mtime and last message role.
146
+
147
+ ## Supported agents
148
+
149
+ | Agent | Session parsing | Detect / install |
150
+ |-------|-----------------|------------------|
151
+ | Cursor | ✅ | ✅ |
152
+ | OpenCode | ✅ | ✅ |
153
+ | Freebuff | ✅ | ✅ |
154
+ | Codex | ✅ | ✅ |
155
+ | Claude Code | ✅ | ✅ |
156
+ | Gemini CLI, Copilot CLI, Amp, Factory, Pi, Kiro, Cline, Roo | listed in Settings | detect + install recipes; parsers welcome |
157
+
158
+ ## Architecture (short)
159
+
160
+ ```
161
+ src/agenthud/
162
+ adapters/ # per-tool collectors (read-only)
163
+ registry.py # agent catalog + install detection
164
+ install.py # install recipes (Terminal / URL)
165
+ native_menubar.py # macOS status item + WKWebView popover
166
+ assets/ # popover.html, settings.html
167
+ tui.py / cli.py
168
+ ```
169
+
170
+ ## Contributing
171
+
172
+ See [CONTRIBUTING.md](CONTRIBUTING.md). Please follow the [Code of Conduct](CODE_OF_CONDUCT.md).
173
+
174
+ ## Security & privacy
175
+
176
+ - Read-only access to local agent stores
177
+ - Freebuff `state.json` tokens are never printed
178
+ - No telemetry, no accounts, no network required for core HUD
179
+
180
+ If you find a vulnerability, open a private security advisory or email the maintainer — do not file a public issue with exploit details.
181
+
182
+ ## License
183
+
184
+ [MIT](LICENSE)
@@ -0,0 +1,156 @@
1
+ # agenthud
2
+
3
+ **Cross-tool agent session HUD for macOS.**
4
+
5
+ See every coding agent at a glance — Cursor, OpenCode, Freebuff, Codex, Claude Code, and more — without alt-tabbing through ten windows.
6
+
7
+ agenthud reads **local session data only** (no cloud login, no usage quotas). It answers: *who is waiting on me, who is running, who errored?*
8
+
9
+ <p align="center">
10
+ <img src="docs/media/demo.gif" alt="agenthud demo — popover tabs and settings" width="420" />
11
+ </p>
12
+
13
+ <p align="center">
14
+ <img src="docs/media/popover.png" alt="agenthud menu bar popover" width="320" />
15
+ &nbsp;
16
+ <img src="docs/media/settings.png" alt="agenthud settings" width="280" />
17
+ </p>
18
+
19
+ > Not affiliated with Cursor, OpenAI, Anthropic, or any agent vendor.
20
+
21
+ ## Why
22
+
23
+ Running multiple agents in parallel is normal now. Finding the one that needs approval is not. agenthud puts a small menu-bar badge and a popover over your local sessions so you can jump straight to the right tool.
24
+
25
+ ## Features
26
+
27
+ - **Menu bar HUD** — status badge (`●` waiting / `✖` error / `▶` running) + popover
28
+ - **Per-agent tabs** — only the agent you select
29
+ - **Auto-detect** — on first launch, enables tools that look installed on this Mac
30
+ - **Settings** — enable/disable agents; **Install** for missing ones (Terminal or download page)
31
+ - **Click to focus** — open the matching app / project when possible
32
+ - **TUI + JSON** — `agenthud`, `agenthud --once`, `agenthud --json`
33
+ - **Privacy-first** — read-only local files; never prints tokens
34
+
35
+ ## Requirements
36
+
37
+ - Python **3.11+**
38
+ - **macOS** for the menu bar UI (PyObjC + WebKit)
39
+ - Linux/macOS terminal TUI works with `rich` only
40
+
41
+ ## Install
42
+
43
+ ### Homebrew (macOS app — recommended)
44
+
45
+ ```bash
46
+ brew trust scs0209/agenthud
47
+ brew install --cask scs0209/agenthud/agenthud
48
+ ```
49
+
50
+ Then open **AgentHUD**, or run `agenthud menubar`.
51
+
52
+ Upgrade: `brew upgrade --cask agenthud`
53
+
54
+ CLI-only (no `.app`):
55
+
56
+ ```bash
57
+ brew trust scs0209/agenthud
58
+ brew install scs0209/agenthud/agenthud
59
+ ```
60
+
61
+ ### pip
62
+
63
+ ```bash
64
+ pip install https://github.com/scs0209/agenthud/releases/download/v0.1.5/agenthud-0.1.5-py3-none-any.whl
65
+ ```
66
+
67
+ PyPI (`pip install agenthud`) is wired via GitHub Actions trusted publishing — publish completes once a PyPI project + trusted publisher (or `PYPI_API_TOKEN` secret) is connected.
68
+
69
+ ### From source
70
+
71
+ ```bash
72
+ git clone https://github.com/scs0209/agenthud.git
73
+ cd agenthud
74
+ python3 -m venv .venv
75
+ source .venv/bin/activate
76
+ pip install -e .
77
+ ```
78
+
79
+ > First launch may show a Gatekeeper prompt (ad-hoc signed). Prefer right-click → **Open**, or:
80
+ > `xattr -dr com.apple.quarantine /Applications/AgentHUD.app`
81
+ >
82
+ > **macOS 26 (Tahoe):** if the app launches but you see nothing, open
83
+ > **System Settings → Menu Bar** and enable **AgentHUD** under
84
+ > “Allow in the Menu Bar” (not leftover `python3.13` entries from older builds).
85
+ > agenthud will also show a guidance dialog when it detects a hidden icon.
86
+ ## Usage
87
+
88
+ ```bash
89
+ agenthud menubar # macOS menu bar (recommended)
90
+ agenthud # terminal live TUI
91
+ agenthud --once # one snapshot
92
+ agenthud --json # machine-readable
93
+ agenthud --tools cursor,codex
94
+ agenthud --max-age-hours 24
95
+ ```
96
+
97
+ Prefs: `~/.config/agenthud/settings.json`
98
+
99
+ ### Environment overrides
100
+
101
+ | Variable | Default |
102
+ |----------|---------|
103
+ | `AGENTHUD_CURSOR_PROJECTS` | `~/.cursor/projects` |
104
+ | `AGENTHUD_OPENCODE_DB` | `~/.local/share/opencode/opencode.db` |
105
+ | `AGENTHUD_FREEBUFF_DIR` | `~/.config/freebuff-desktop` |
106
+
107
+ ## Status legend
108
+
109
+ | Status | Meaning |
110
+ |--------|---------|
111
+ | `waiting` | Needs you |
112
+ | `running` | Recent activity / turn in flight |
113
+ | `error` | Last turn failed |
114
+ | `idle` | Quiet |
115
+ | `done` | Finished / stale |
116
+
117
+ Statuses are **best-effort heuristics** from local logs/DBs. Agents without a live status API are inferred from mtime and last message role.
118
+
119
+ ## Supported agents
120
+
121
+ | Agent | Session parsing | Detect / install |
122
+ |-------|-----------------|------------------|
123
+ | Cursor | ✅ | ✅ |
124
+ | OpenCode | ✅ | ✅ |
125
+ | Freebuff | ✅ | ✅ |
126
+ | Codex | ✅ | ✅ |
127
+ | Claude Code | ✅ | ✅ |
128
+ | Gemini CLI, Copilot CLI, Amp, Factory, Pi, Kiro, Cline, Roo | listed in Settings | detect + install recipes; parsers welcome |
129
+
130
+ ## Architecture (short)
131
+
132
+ ```
133
+ src/agenthud/
134
+ adapters/ # per-tool collectors (read-only)
135
+ registry.py # agent catalog + install detection
136
+ install.py # install recipes (Terminal / URL)
137
+ native_menubar.py # macOS status item + WKWebView popover
138
+ assets/ # popover.html, settings.html
139
+ tui.py / cli.py
140
+ ```
141
+
142
+ ## Contributing
143
+
144
+ See [CONTRIBUTING.md](CONTRIBUTING.md). Please follow the [Code of Conduct](CODE_OF_CONDUCT.md).
145
+
146
+ ## Security & privacy
147
+
148
+ - Read-only access to local agent stores
149
+ - Freebuff `state.json` tokens are never printed
150
+ - No telemetry, no accounts, no network required for core HUD
151
+
152
+ If you find a vulnerability, open a private security advisory or email the maintainer — do not file a public issue with exploit details.
153
+
154
+ ## License
155
+
156
+ [MIT](LICENSE)
Binary file
Binary file
Binary file
@@ -0,0 +1,60 @@
1
+ [project]
2
+ name = "agenthud"
3
+ version = "0.1.5"
4
+ description = "Cross-tool agent session HUD for Cursor, OpenCode, Freebuff, Codex, and more"
5
+ readme = "README.md"
6
+ requires-python = ">=3.11"
7
+ license = { text = "MIT" }
8
+ authors = [{ name = "ayaan", email = "scs0209@users.noreply.github.com" }]
9
+ keywords = ["agents", "cursor", "opencode", "freebuff", "codex", "claude", "hud", "menubar", "cli"]
10
+ dependencies = [
11
+ "rich>=13.0",
12
+ "pyobjc-framework-Cocoa>=10; sys_platform == 'darwin'",
13
+ "pyobjc-framework-WebKit>=10; sys_platform == 'darwin'",
14
+ ]
15
+ classifiers = [
16
+ "Development Status :: 4 - Beta",
17
+ "Environment :: Console",
18
+ "Environment :: MacOS X",
19
+ "License :: OSI Approved :: MIT License",
20
+ "Operating System :: MacOS",
21
+ "Programming Language :: Python :: 3",
22
+ "Programming Language :: Python :: 3.11",
23
+ "Programming Language :: Python :: 3.12",
24
+ "Programming Language :: Python :: 3.13",
25
+ "Topic :: Utilities",
26
+ ]
27
+
28
+ [project.urls]
29
+ Homepage = "https://github.com/scs0209/agenthud"
30
+ Repository = "https://github.com/scs0209/agenthud"
31
+ Issues = "https://github.com/scs0209/agenthud/issues"
32
+ Release = "https://github.com/scs0209/agenthud/releases"
33
+
34
+ [project.scripts]
35
+ agenthud = "agenthud.cli:main"
36
+
37
+ [build-system]
38
+ requires = ["hatchling"]
39
+ build-backend = "hatchling.build"
40
+
41
+ [tool.hatch.build.targets.wheel]
42
+ packages = ["src/agenthud"]
43
+
44
+ [tool.hatch.build.targets.wheel.sources]
45
+ "src/agenthud" = "agenthud"
46
+
47
+ [tool.hatch.build.targets.sdist]
48
+ include = [
49
+ "src/agenthud",
50
+ "docs/media",
51
+ "README.md",
52
+ "LICENSE",
53
+ "CONTRIBUTING.md",
54
+ "CODE_OF_CONDUCT.md",
55
+ "pyproject.toml",
56
+ ]
57
+
58
+ [tool.hatch.build.targets.wheel.force-include]
59
+ "src/agenthud/assets/popover.html" = "agenthud/assets/popover.html"
60
+ "src/agenthud/assets/settings.html" = "agenthud/assets/settings.html"
@@ -0,0 +1,3 @@
1
+ """Cross-tool agent session HUD."""
2
+
3
+ __version__ = "0.1.5"
@@ -0,0 +1,4 @@
1
+ from agenthud.cli import main
2
+
3
+ if __name__ == "__main__":
4
+ main()
@@ -0,0 +1 @@
1
+ """Adapter package."""