fix: doc audit — relay bin, env var names, CLI flag formats - #8
Merged
Conversation
Fixes found by auditing every doc claim against actual code: - Add bin entry to @authmesh/relay so npx @authmesh/relay works - Add shebang to relay start.ts for executable usage - Fix RELAY_URL → AMESH_RELAY_URL everywhere (matches actual CLI env var) - Fix --ttl 3600 → --ttl 1h (CLI accepts duration format, not seconds) - Fix createRelay → createRelayServer in relay README - Fix bunx → npx in all docs (relay has no bunx support) - Simplify guide.md relay start to use npx - Add AUTH_MESH_PASSPHRASE to env vars table on site
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.
Summary
Full audit of every doc claim against actual code. Fixes 6 discrepancies:
bunx @authmesh/relaysilently failed. Addedbin.amesh-relayto package.json + shebang to start.ts. Changed all docs tonpx @authmesh/relay.RELAY_URLdoesn't exist — CLI actually readsAMESH_RELAY_URL. Fixed in integration guide, CLI README, and landing page env vars table.--ttl 3600is invalid — CLI accepts duration format (1h,30m), not raw seconds. Fixed in integration guide and landing page.createRelay()doesn't exist — actual export iscreateRelayServer(). Fixed in relay README.node -erelay start — simplified tonpx @authmesh/relayin guide.md.AUTH_MESH_PASSPHRASEmissing from env vars — added to landing page integration docs table.Test plan
bun run build— all packages buildbun run test— all tests passbun run lint— cleannpx @authmesh/relay— verify it starts (requires published package with bin entry)