Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions external_plugins/zcode-herdr-status/.zcode-plugin/plugin.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "zcode-herdr-status",
"version": "0.2.1",
"description": "Opt-in Linux status bridge from ZCode Hooks to the current Herdr pane, with an optional version-pinned metadata adapter.",
"description_i18n": {
"en": "Opt-in Linux status bridge from ZCode Hooks to the current Herdr pane, with an optional version-pinned metadata adapter.",
"zh-CN": "在 Linux 当前 Herdr 窗格中显式启用的 ZCode Hooks 状态桥接,可选用锁定版本的元数据适配器。"
},
"author": {
"name": "Bin Liu"
},
"license": "Apache-2.0",
"keywords": [
"herdr",
"status",
"hooks",
"linux"
]
}
202 changes: 202 additions & 0 deletions external_plugins/zcode-herdr-status/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

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.
68 changes: 68 additions & 0 deletions external_plugins/zcode-herdr-status/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# ZCode Herdr status bridge

[中文说明](README_CN.md)

An opt-in **Standard plugin** for Linux: show the ZCode agent in the **current Herdr pane** as working, waiting for permission, or unknown. No MCP App, web server, session manager, or Ovis patch is included. Herdr and Ovis are independent projects; this package is not endorsed by them.

## Requirements and limits

- Linux with `/proc`, Python 3.10+ (standard library only), ZCode **3.16.3** (CLI 0.17.0), Herdr **0.9.5**. Other versions fail the check; this is an intentionally narrow initial compatibility range.
- An already running Herdr pane owned by your user, with inherited `HERDR_ENV`, `HERDR_PANE_ID`, and `HERDR_SOCKET_PATH`. Do not fabricate those values from another shell. Your working directory must match the pane.
- Install and enable this plugin using ZCode's plugin manager, then use a **new, otherwise idle shell pane**. Normal ZCode sessions do not opt in automatically. Keep other status bridges disabled for this pane.
- Hooks alone cannot prove completion, cancellation, or a TUI permission rejection that emits no terminal Hook. `Stop` can be followed by another model iteration. In the default mode `Stop` becomes **unknown / Completion unverified**, not success. Unknown is never acceptance.
- Hooks-only hints also expire after 30 seconds without a new Hook and become **unknown / Status unverified**. This covers failures without a terminal Hook, but a legitimate long model generation or permission wait can also become unknown. Only new evidence refreshes the hint; no polling heartbeat fabricates activity.
- Optional `--experimental-db-status` uses private, version-pinned ZCode SQLite metadata. This is **not a public API**. It projects only IDs, timestamps, roles, finish/error classifications and tool lifecycle status for the exact bound session and current user-message parent; it does not return message text, reasoning, tool arguments or outputs. An unreadable/replaced/incompatible database produces unknown. Upgrades require revalidation and a new compatible release.
- The bridge does not fix authentication. A prior isolated trial encountered `project_token_login_failed`; re-login restored calls, but its cause was not established. Do not assume unattended reliability.

## Install and start

Install/enable `zcode-herdr-status` from the marketplace. For source development, follow the repository's [local marketplace workflow](../../docs/PLUGIN_DEVELOPMENT.md#18-test-a-plugin-locally). Find this plugin's enabled installation `rootPath` with `zcode plugins list --json`; set `PLUGIN` to that directory. Run these commands yourself in the new Herdr shell pane:

```bash
python3 "$PLUGIN/hooks/bridge.py" doctor
python3 "$PLUGIN/hooks/bridge.py" run
```

The bridge starts `zcode` with **no permission, model, language or tool-policy overrides**. Optional native arguments go after `--`; they are your explicit choice. Non-default executable locations can be supplied with `--herdr` and `--zcode`. Do not bypass confirmation/security policies to make a trial pass.

For more precise lifecycle reasons, explicitly opt in:

```bash
python3 "$PLUGIN/hooks/bridge.py" doctor --experimental-db-status
python3 "$PLUGIN/hooks/bridge.py" run --experimental-db-status
```

The default experimental database is the current user's `$HOME/.zcode/cli/db/db.sqlite`; `--db` permits another same-user regular file, never a remote database. The runtime version remains pinned. A successful doctor check verifies local installation/binding/schema, **not model login or connectivity**.

The launcher prints its run directory. `--state-dir` selects a private 0700 directory; default is `ZCODE_PLUGIN_DATA` when inherited, otherwise `$XDG_STATE_HOME/zcode-herdr-status` (fallback `$HOME/.local/state/zcode-herdr-status`). A per-socket/pane lock prevents duplicate observers from this state directory. Do not start competing copies with different state directories in the same pane.

## Stop, disable and rollback

From another terminal under the same user, use the exact run directory printed above:

```bash
python3 "$PLUGIN/hooks/bridge.py" stop "$RUN_DIR"
```

This stops only the observer and releases its own Herdr source; the native ZCode process continues. A missing release acknowledgement is reported as a failure, not clean shutdown. Disabling the plugin through ZCode is also detected by the observer's local inventory check (normally within five seconds, plus command timeouts). Exit the native session normally, then uninstall the plugin to return to the pre-install state. No prior plugin settings or credentials are restored/replaced because this plugin never changes them. Retain private run evidence if needed; delete only your own printed run directory after processes have exited.

Default observer lifetime is one hour, configurable with `--max-seconds` from 1 to 86400. On lifetime expiry, parent/native exit, plugin disable, or socket replacement the observer stops and tries to clear only its own source. It never kills the native agent. If Herdr is unreachable, release cannot be proven; inspect/reconnect rather than treating old UI state as fresh. An external UI's disconnected-state presentation is outside this plugin's scope.

## Side effects, privacy and provenance

- Automatic `process` Hooks: SessionStart, UserPromptSubmit, PreToolUse, PermissionRequest, PostToolUse, PostToolUseFailure, Stop. They use `python3`, produce no stdout decisions/context, and are no-ops without the opt-in launch binding. Hook input is parsed transiently; only allowlisted lifecycle metadata is persisted, not prompts or credentials. This is an observer, **not a sandbox or permission authority**.
- Executes existing ZCode/Herdr binaries using argv, local plugin-inventory commands, and a bounded Python observer. The inherited socket's owner/inode and PID/start-time/UID lineage are checked; it never selects a UI-focused target or controls another session. No shell evaluation, input injection, approvals, service installation, runtime download or cloud access.
- Writes private lock, binding, sequence, event and stop-receipt files in the chosen state directory. Optional database access is read-only. Logs can contain session IDs and local paths; keep them private and do not submit raw logs/screenshots from customer work.
- No network requests, telemetry, model calls, API keys or fees are introduced by the observer itself. The native ZCode process uses your existing model/account/network configuration and may incur its normal usage costs. Herdr communication is over the existing local Unix socket.
- This bridge's source is Apache-2.0 (see LICENSE), adapted from an internal observational prototype. No ZCode, Herdr or Ovis binaries/source assets are bundled. ZCode and Herdr remain user-installed external dependencies under their own terms. Ovis is optional and is not part of the supported runtime check.

## Verification

```bash
python3 -B -m unittest discover -s external_plugins/zcode-herdr-status/tests -v
python3 scripts/validate.py
python3 scripts/build_dist.py
git diff --check
```

Use synthetic/local checks before real model use. Then, in an isolated profile, verify doctor, one new pane, a harmless prompt, permission rejection, cancellation, native exit, explicit observer stop while native remains alive, and plugin disable. Check a second unrelated pane remains untouched. Inspect both the UI and `transitions.jsonl` / `stopped.json`; transport acknowledgement is not task/content acceptance. Default hooks-only and experimental metadata modes must be judged against their different contracts. A prior internal prototype passed a short real-task trial; that evidence alone does not establish this portable version's compatibility or long-term reliability.
Loading