@inline-chat/hermes-agent-adapter 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+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.

package/README.md

@@ -0,0 +1,315 @@
+# @inline-chat/hermes-agent-adapter
+
+Inline platform plugin for Hermes Agent.
+
+This package installs an external Hermes platform plugin named `inline` and a
+supervised Node sidecar that uses `@inline-chat/realtime-sdk` for Inline
+realtime transport.
+
+Implemented Hermes-native surfaces:
+
+- realtime inbound messages, replies, and action callbacks
+- outbound text, markdown, opt-in edit-message streaming, deletes, typing, media uploads, and reply threads
+- Discord-style native Hermes `inline` tool for bounded chat/message/history/thread actions
+- clarify prompts, command approvals, slash confirmations, and model picker buttons
+- Hermes slash commands synced into Inline's native `/` bot command menu
+- DM/group access policy controls compatible with Hermes gateway allowlists
+- installer, doctor, dry-run, and live `test-send` probes
+
+## Feature Support
+
+Supported:
+
+- Install, status, doctor, dry-run, and live `test-send` commands.
+- External Hermes platform registration as `inline`.
+- `INLINE_TOKEN`, `INLINE_BOT_TOKEN`, `platforms.inline.token`, and `inline.token` auth paths, including simple `${ENV_NAME}` config references.
+- Supervised loopback Node sidecar using the Inline realtime SDK.
+- Realtime inbound messages, catch-up, replies to bot messages, and action callbacks.
+- Outbound text, Markdown parsing, opt-in edit-message streaming, long-message splitting, edits, deletes, typing, and presence.
+- Inline reply-thread routing, default DM/group auto-threading, `/threads` controls, parent chat metadata, parent/thread prompt fallback, and thread-specific skill bindings.
+- Native Hermes `inline` tool for current-chat/thread reads, bounded history, exact message lookup, sending, editing, deleting bot-owned messages, typing/presence, and reply-thread creation.
+- Per-turn Inline sender/chat/thread IDs, with prompt guidance for sender mentions and current chat/thread Markdown links.
+- OpenClaw-style entity summaries for live turns and tool-fetched history, including mentions, text links, thread links, thread-title links, code/pre blocks, bot commands, and group mentions as untrusted Hermes context.
+- DM and group policies, user allowlists, group sender allowlists, mention requirements, strict mention mode, allowed chats, and free-response chats.
+- Native Inline `/` command-menu sync for Hermes slash commands, including `/threads` and `/update`; typed slash commands continue to work even if menu sync is disabled or rejected.
+- Inline-native buttons for clarify prompts, command approvals, slash confirmations, and model selection.
+- Outbound local photo, video, voice, and document uploads with configurable size caps.
+- Inbound photo, video, voice, and document summaries, with URL-backed media cached locally for Hermes when available.
+- Reactions on bot messages, plus opt-in lifecycle/system events as synthetic Hermes messages.
+- Cron or standalone sends through `INLINE_HOME_CHANNEL` and `hermes send --to inline:<chat-id>`.
+- Hermes-native `typing_indicator` and `gateway_restart_notification` toggles, with plugin-owned YAML bridge coverage for external-plugin compatibility.
+
+Unsupported or intentionally limited:
+
+- Multiple Inline accounts in one Hermes process. Run separate Hermes instances for separate tokens.
+- Inline member, space, search, and admin tools beyond bounded current-chat/thread message access.
+- Full Inline rich-text span conversion. Outbound formatting uses Inline Markdown parsing; rich entities are summarized for the agent instead of converted into Hermes-specific spans.
+- Native animated draft streaming. Inline can stream by sending one preview message and editing it, but this edit-based streaming path is off by default like Discord and Slack.
+- Ephemeral in-channel private replies. Private notices are sent as DMs when a user id is available.
+- Live voice sessions or calls. Voice file messages are supported, but realtime audio is not.
+- Media without a usable Inline CDN/local URL. Those messages still produce text summaries, but Hermes may not receive a local file path.
+
+## Install
+
+```sh
+npm install -g @inline-chat/hermes-agent-adapter
+inline-hermes install
+hermes plugins enable inline-platform
+```
+
+For local development:
+
+```sh
+cd packages/hermes-agent
+bun run build
+node dist/install.js install --link --hermes-home ~/.hermes
+cd ~/dev/hermes-agent
+uv run ./hermes plugins enable inline-platform
+```
+
+Check an installation:
+
+```sh
+inline-hermes doctor --json
+hermes inline status
+inline-hermes --version
+```
+
+`doctor` verifies required plugin files, the Node executable used for the
+sidecar, the installed sidecar bundle hash, and whether Hermes config enables
+the external plugin with `plugins.enabled: [inline-platform]`. It honors
+`INLINE_NODE_BIN` and fails if that explicit path is missing, not executable,
+older than Node 20, or cannot report a Node version. It also fails if a copied
+plugin has drifted from the package bundle.
+
+Confirm Hermes sees the plugin:
+
+```sh
+cd ~/dev/hermes-agent
+uv run ./hermes plugins list --plain --no-bundled
+```
+
+Expected local output includes:
+
+```text
+enabled      user     0.0.1    inline-platform
+```
+
+## Update Or Reinstall
+
+After upgrading the npm package, refresh the installed Hermes plugin copy:
+
+```sh
+npm install -g @inline-chat/hermes-agent-adapter@latest
+inline-hermes install --force
+inline-hermes --version
+inline-hermes doctor --json
+```
+
+`install --force` replaces the copied plugin files under
+`~/.hermes/plugins/inline` or refreshes a dev symlink target. It does not edit
+`config.yaml`, tokens, or other Hermes state. If `doctor` reports a sidecar hash
+mismatch, rerun the same command after rebuilding or upgrading the package.
+
+## Compatibility
+
+- Hermes Agent: requires the external user plugin registry and native platform
+  plugin loader available in Hermes Agent `0.17.x`. This package was validated
+  against Hermes Agent `0.17.0` from source commit `824f2279`.
+- Node.js: `>=20` is required for the bundled sidecar. Hermes-managed Node 22,
+  system Node, or an explicit `INLINE_NODE_BIN` path all work.
+- Inline transport: the sidecar uses `@inline-chat/realtime-sdk@0.0.11` and is
+  bundled into the npm package, so Hermes startup does not run `npm install`.
+- Live sends require a valid Inline user or bot token in `INLINE_TOKEN`,
+  `INLINE_BOT_TOKEN`, `platforms.inline.token`, or `inline.token`.
+
+Use `hermes plugins list --plain --no-bundled` to verify external plugin
+registration. Other Hermes channel listings may be limited to bundled platforms
+depending on the Hermes version, but `hermes send --to inline:<chat-id> ...`
+and the gateway path load the external plugin through Hermes' platform registry
+after `hermes plugins enable inline-platform`.
+
+## Maintainer Preflight
+
+Before publishing, run:
+
+```sh
+bun run release:preflight
+```
+
+This runs `npm publish --dry-run --access public`. npm invokes
+`prepublishOnly`, so the dry-run must pass `bun run check`, rebuild the packed
+runtime files, verify the shipped `inline-hermes` binary, and print the final
+tarball contents without publishing.
+
+Maintainers should also run the manual live-test and publish checklist in
+[`packages/hermes-agent/RELEASE.md`](https://github.com/inline-chat/inline/blob/main/packages/hermes-agent/RELEASE.md).
+
+## Smoke Test
+
+Dry-run mode validates target parsing and package wiring without a token:
+
+```sh
+inline-hermes test-send --dry-run --to chat:123 --text "Inline Hermes dry-run" --json
+```
+
+With a valid Inline bot or user token in the environment or Hermes config,
+`test-send` starts the bundled sidecar on a loopback port, waits for realtime
+readiness, sends one message, and shuts the sidecar down:
+
+```sh
+export INLINE_TOKEN="<token>"
+inline-hermes test-send --to chat:123 --text "Inline Hermes test"
+```
+
+Use `--json` for automation. Tokens are read from `INLINE_TOKEN`,
+`INLINE_BOT_TOKEN`, `platforms.inline.token`, or `inline.token`; the CLI
+intentionally does not accept token arguments. If the token is expired or
+revoked, the JSON `issues` array includes the server connection reason, for
+example `SESSION_REVOKED`.
+
+## Configure
+
+Set an Inline token in the Hermes gateway environment:
+
+```sh
+export INLINE_TOKEN="<token>"
+```
+
+Then enable the platform in Hermes config:
+
+```yaml
+platforms:
+  inline:
+    enabled: true
+```
+
+Inline follows Hermes' native work-chat defaults: show typing/presence while a
+turn is running, keep tool-call progress out of the room by default, and keep
+edit-based token streaming opt-in. If an older Hermes config has global
+`display.tool_progress: all`, add the per-platform override below so terminal
+and tool progress bubbles are not left in Inline chats:
+
+```yaml
+display:
+  platforms:
+    inline:
+      tool_progress: off
+      cleanup_progress: true
+      streaming: false
+      interim_assistant_messages: false
+```
+
+To temporarily show live tool progress, set `tool_progress: new` or
+`tool_progress: all` and leave `cleanup_progress: true` so Hermes deletes the
+progress message after a successful final reply. Token streaming requires both
+top-level `streaming.enabled: true` and
+`display.platforms.inline.streaming: true`.
+
+Hermes also accepts a top-level `inline:` block for plugin-owned settings, but
+`platforms.inline` matches the shape used by most Hermes platform docs and is
+the safest form to copy into `~/.hermes/config.yaml`.
+
+If you intentionally keep the token in `config.yaml` instead of the gateway
+environment, set `platforms.inline.token` directly. The adapter also accepts
+`inline.token` and simple `${ENV_NAME}` references in either token field,
+resolving them from the process environment at runtime. Environment variables
+remain the preferred production path for secrets.
+
+Access control follows Hermes' native platform model:
+
+| Setting | Purpose |
+| --- | --- |
+| `INLINE_ALLOWED_USERS` | Comma-separated Inline user ids allowed to DM the bot. Setting this also makes the adapter treat DMs as allowlisted unless `INLINE_DM_POLICY` is set. |
+| `INLINE_ALLOW_ALL_USERS=true` | Explicit Hermes gateway allow-all switch for Inline. Use only for trusted/dev deployments. |
+| `INLINE_DM_POLICY=open|allowlist|disabled` | Controls direct-message intake. `allowlist` requires `INLINE_ALLOWED_USERS` or config `allow_from`. |
+| `INLINE_GROUP_POLICY=open|allowlist|disabled` | Controls group intake. `allowlist` requires `INLINE_GROUP_ALLOW_FROM`. |
+| `INLINE_GROUP_ALLOW_FROM` | Comma-separated Inline user ids allowed to invoke the bot from group chats. |
+| `INLINE_REQUIRE_MENTION` | Requires a mention or wake word in groups by default. Replies to the bot are accepted without the wake word. |
+| `INLINE_STRICT_MENTION` | Requires a mention or wake word on every group turn, including replies to the bot. Defaults to `false`. |
+| `INLINE_ALLOWED_CHATS` | Comma-separated group/thread chat ids where the bot may respond. Parent chat ids also match their Inline reply threads. DMs are not filtered. Empty means no chat restriction. |
+| `INLINE_FREE_RESPONSE_CHATS` | Comma-separated group/thread chat ids where no mention is required. Parent chat ids also match their Inline reply threads. Useful for dedicated agent rooms. |
+| `INLINE_REPLY_THREADS` | Creates/uses Inline reply threads for top-level DM and group replies by default. Accepts `true`/`false`, `on`/`off`, `auto`, `thread`, or `flat`; defaults to `true`. |
+| `INLINE_SETTINGS_PATH` | JSON settings file for per-chat `/threads` overrides. Defaults next to `INLINE_STATE_PATH`; `.env`-like paths are refused. |
+| `INLINE_SYSTEM_EVENTS` | Delivers Inline lifecycle events such as edits, deletes, and participant changes as synthetic messages. Defaults to `false`. Reactions on bot messages are always delivered. |
+| `INLINE_MENTION_PATTERNS` | JSON list, comma-separated, or newline-separated regex patterns for group wake words. |
+| `INLINE_PARSE_MARKDOWN` | Controls whether outbound Hermes Markdown is parsed by Inline. Defaults to `true`. |
+| `INLINE_SYNC_COMMANDS` | Syncs Hermes slash commands into Inline's native `/` bot command menu on gateway connect. Defaults to `true`. |
+| `INLINE_COMMAND_LIMIT` | Caps native Inline bot command sync. Must be `1` through `100`; defaults to `100`. |
+| `INLINE_MEDIA_MAX_MB` | Maximum inbound media download size for URL-backed Inline attachments. Defaults to `25`. |
+| `INLINE_UPLOAD_MAX_MB` | Maximum outbound local file upload size. The Python adapter and Node sidecar both enforce it before upload bytes are read. Defaults to `300`. |
+| `INLINE_STATE_PATH` | Persistent Inline SDK state file. Defaults to `~/.hermes/inline/sdk-state.json`. |
+| `INLINE_RPC_TIMEOUT_MS` | Realtime RPC timeout for the Node sidecar. |
+| `INLINE_CONNECT_TIMEOUT_MS` | Adapter startup timeout while waiting for the sidecar to become realtime-ready. Defaults to `20000`. |
+| `INLINE_CONNECT_RETRY_INITIAL_MS` | Initial sidecar retry delay after realtime startup failure. Defaults to `1000`. |
+| `INLINE_CONNECT_RETRY_MAX_MS` | Maximum sidecar retry delay after repeated realtime startup failures. Defaults to `15000`. |
+| `INLINE_SIDECAR_PORT` | Fixed loopback port for the sidecar. Must be `1` through `65535`. Defaults to `8794`; `test-send` uses a random free port. |
+| `INLINE_SIDECAR_BIND` | Sidecar bind host. Must be loopback: `127.0.0.1`, `localhost`, or `::1`. Defaults to `127.0.0.1`. |
+| `platforms.inline.typing_indicator` | Hermes-native toggle for Inline typing/presence while a turn is running. Defaults to `true`; set to `false` to keep busy threads visually quiet. |
+| `platforms.inline.gateway_restart_notification` | Hermes-native toggle for gateway online/restarted notices. Defaults to `true`. |
+
+Equivalent Hermes YAML can use `allow_from`, `allowed_users`,
+`group_allow_from`, `dm_policy`, `group_policy`, `require_mention`,
+`strict_mention`, `allowed_chats`, `free_response_chats`, `reply_threads`,
+`settings_path`, and
+`mention_patterns` under the Inline platform config. Operational settings such
+as `base_url`, `parse_markdown`, `media_max_mb`, `upload_max_mb`,
+`state_path`, `sidecar_port`, `connect_timeout_ms`, `sync_commands`, and
+`command_limit` can also be set there.
+Env allowlists are still preferred for production because the Hermes gateway
+also sees them directly.
+Use a JSON list for mention regexes that contain commas, for example
+`["hermes\\b[:,]?"]`.
+
+Inline also supports Hermes' native thread/channel prompt and skill bindings.
+Use raw Inline chat/thread ids for these bindings. Inline reply-thread chats
+are checked first, then their parent chat id:
+
+```yaml
+platforms:
+  inline:
+    channel_prompts:
+      "123": "Treat this Inline thread as the customer escalation room."
+    channel_skill_bindings:
+      - id: "123"
+        skills: ["support-triage", "incident-report"]
+```
+
+Inline-native button callbacks, such as approvals and clarify choices, require
+the clicking actor to pass an explicit Inline or global Hermes allowlist, or
+`INLINE_ALLOW_ALL_USERS=true` / `GATEWAY_ALLOW_ALL_USERS=true`. This includes
+model-picker callbacks. The stricter callback gate prevents group-visible
+buttons from becoming a bypass when message intake is otherwise `open`.
+
+On gateway startup, the adapter derives the Inline `/` menu from Hermes'
+central slash-command registry, normalizes names to Inline Bot API constraints
+(`^[a-z0-9_]+$`, max 32 characters), and calls `setMyCommands`. If Inline
+rejects the full list with `BOT_COMMANDS_TOO_MUCH`, the adapter retries with a
+smaller prefix. Menu sync failures are logged as warnings and do not prevent
+message transport; `/commands` remains the full fallback list.
+
+The plugin id is `inline`, which is intentionally the same id an eventual
+bundled Hermes adapter should use.
+
+## Troubleshooting
+
+Run `inline-hermes doctor --json` first. It checks the installed plugin path,
+required files, Node executable, and source/installed sidecar bundle hashes.
+
+- `plugin is not installed`: run `inline-hermes install`.
+- `Hermes plugin 'inline-platform' is not enabled`: run
+  `hermes plugins enable inline-platform`.
+- `installed sidecar bundle does not match`: re-run
+  `inline-hermes install --force` after upgrading this package.
+- `node executable was not detected`, `INLINE_NODE_BIN does not exist`, or
+  `must be Node.js >=20`: install Node.js 20+ or set `INLINE_NODE_BIN` to the
+  Node executable Hermes should use.
+- `SESSION_REVOKED` during `test-send`: the Inline token reached the realtime
+  service but was rejected. Re-authenticate or rotate the bot/user token and
+  retry.
+- `sidecar was not ready`: inspect the JSON `health` and `logs` fields from
+  `test-send --json`; token, base URL, or realtime startup failures are exposed
+  there with retry diagnostics.
+- `INLINE_SIDECAR_BIND must be loopback`: remove the override or set it to
+  `127.0.0.1`, `localhost`, or `::1`. The sidecar intentionally refuses
+  externally reachable bind addresses even though its HTTP API is token-gated.

package/dist/install.d.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+export declare function main(argv?: string[]): Promise<number>;
+export declare function describeHealthFailure(health: unknown): string | null;
+//# sourceMappingURL=install.d.ts.map