docs: remove Bun-runtime callout from remote-shell (post v0.4.0) - #18
Merged
Conversation
…ips binaries
Follow-up to v0.4.0. The prebuilt amesh-agent binaries are live in the
GitHub release, the npm postinstall actually downloads them, and
`brew install ameshdev/tap/amesh` installs both amesh and amesh-agent.
Verified end-to-end in a fresh Linux x64 Docker container:
npm install -g @authmesh/agent@0.4.0 -> postinstall downloads binary
which amesh-agent -> /usr/local/bin/amesh-agent (symlink to launcher)
amesh-agent --version -> amesh-agent/0.4.0
amesh-agent agent start --help -> full command help (not topic help)
No Bun wrapper required on supported platforms.
Changes:
landpage/src/routes/docs/remote-shell/+page.svelte
- Re-add Homebrew install option for the server side (single tap
installs both amesh and amesh-agent now).
- Re-add binary tarball install option pointing at the combined
amesh-{version}-{platform}-{arch}.tar.gz archive and extracting the
amesh-agent binary.
- Remove the amber 'Runtime requirement' callout that warned about the
Bun dependency and the bun $(which amesh-agent) agent start wrapper.
- Add a new 'Platform Support' section with a table listing the four
supported targets (macOS arm64/x64, Linux x64/arm64) and the armv7
exclusion, so users can see at a glance where they stand.
- Update the inline TOC to include the new Platform Support anchor.
- Troubleshooting card for 'Handshake failed' no longer references the
Bun wrapper; the armv7 entry is now framed as 'unsupported
architectures only'.
landpage/src/routes/docs/troubleshooting/+page.svelte
- Reframe the 'requires Bun runtime' entry: on supported platforms this
error should never appear (postinstall bundles Bun in the binary); if
it does, most likely the postinstall couldn't reach GitHub releases.
- Keep the armv7 fallback guidance as a secondary paragraph.
- 'Handshake failed' entry no longer mentions the Bun wrapper.
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
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.
Summary
Follow-up to v0.4.0. The prebuilt
amesh-agentbinaries are live in the GitHub release, the npm postinstall successfully downloads them, andbrew install ameshdev/tap/ameshinstalls bothameshandamesh-agent. This PR updates the/docs/remote-shelland/docs/troubleshootingpages to reflect that reality — the amber "Runtime requirement" callout can come off and the Homebrew / binary install tabs can come back.End-to-end verification (Docker, before this PR)
Fresh
node:20-bookworm-slimcontainer onlinux/amd64:The
amesh-agent/0.4.0output format is unique to the compiledsea.tsbinary — confirming the postinstall extracted the real binary, not that it fell through to the JS fallback. Nested command dispatch works. Nobunwrapper needed.Changes
landpage/src/routes/docs/remote-shell/+page.sveltebrew install ameshdev/tap/amesh(same as the controller). A single tap install puts both binaries inPATH.amesh-linux-x64.tar.gzand extractsamesh-agent. The tarballs contain both binaries so the same archive works for both sides.bun $(which amesh-agent) agent start— no longer necessary on supported platforms.landpage/src/routes/docs/troubleshooting/+page.svelteTest plan
bun run build(landpage) — cleanbun run check— 0 errorsnpm install -g @authmesh/agent@0.4.0in a fresh Linux x64 Docker container,amesh-agent --versionandamesh-agent agent start --helpwork without any wrapper