Say that cli mode needs a binary we do not ship - #13
Merged
Conversation
The default mode depends on the Hookdeck CLI, and Install never mentioned it. The only reference anywhere in the README was a line in Connection modes describing what the CLI does, not how to get it — so a reader could follow every documented step, have a correct configuration, and still have a gateway that refuses to start. It is not bundled and pip cannot install it: it is a separate Go binary. Also records that no `hookdeck login` is needed. That was true when the README was written and stopped being true when the gateway started authenticating a CLI session of its own from the API key — which is worth stating positively, since "log in first" is the reasonable assumption and doing it by hand is how the two projects drift apart. `doctor` already catches all of this. It should not be the first place a reader learns it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The default mode depends on the Hookdeck CLI, and Install never mentioned it. The only reference anywhere in the README was one line under Connection modes describing what the CLI does — not how to get it.
So a reader could follow every documented step, end up with a correct configuration, and still have a gateway that refuses to start:
It is not bundled and pip cannot install it — it is a separate Go binary. Confirmed against
pyproject.toml: the only dependencies areaiohttpandhttpx.Adds the install step to the README, and the same to
docs/operations.mdwhere CLI mode is described in full.Also worth stating: no
hookdeck loginThat was true when the README was written, and stopped being true once the gateway began authenticating a CLI session of its own from
HOOKDECK_EG_API_KEY(defaultcli_config_path→~/.hermes/hookdeck/cli-config.toml).Worth saying positively rather than leaving out, because "log in first" is the reasonable assumption — and doing it by hand is exactly how the two projects drift apart, which is the failure #4 was about.
doctoralready catches every one of these. It should not be the first place a reader finds out.Docs only —
README.mdanddocs/are outsidehookdeck/, so nothing ships and no release is needed. Based onmain, independent of the #10 → #11 → #12 stack.