Correct README, npm README and install.sh where they describe a CLI that does not exist - #12
Merged
Merged
Conversation
ADR-0104 removed VM memory snapshots on 2026-08-20: a pause saves the disk only and every start is a cold boot, so "resumes mid-session" describes a mechanism that is gone. Say what is true and still the reason to use this: the disk survives, a paused workspace costs nothing and picks up from its last save. Three more things these files claimed that the shipped 0.4.5 binary does not do. "Get started" taught the retired v0.1.0 grammar (`ws list`, `ws create --name`), all of it hidden in the binary and absent from every generated completion, so a reader who followed it and then ran `--help` saw a different CLI. `npx @reachpad/cli run scratch -- cargo test` addressed a workspace by its label, and there is no name resolution in the CLI, so it fails with "There is no workspace scratch on this account". And the source description named a `runtime` crate; the snapshot has carried only `proto` and `authz` since v1 dropped runtime from the CLI's dependencies. install.sh had no Darwin/x86_64 case, so the advertised one-liner failed on an Intel Mac with "no prebuilt binary" while the release has shipped reachpad-x86_64-apple-darwin.tar.gz all along, listed in the SHA256SUMS the installer verifies. Add the case: every platform the table maps now resolves to an asset the release publishes, and every published asset is reachable.
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.
A truth pass over the repo-local documentation in this snapshot. Nothing in the synced Rust source changed:
reachpad/andcrates/at 0.4.5 are already clean of the memory claims (upstreamcli.rssays "Save disk, then stop the meter", andattachis a visible verb now), so every fix here is in a file the release sync preserves rather than overwrites.Memory resume
ADR-0104 (accepted 2026-08-20) removed VM memory snapshotting entirely. A pause saves the disk, every start is a cold boot, files survive and running processes do not. The README opened by promising the opposite.
npm/cli/README.md'spauseline loses "and memory" for the same reason. (npm/README.mdturned out to make no memory claim; checked, unchanged.)Commands that do not work
reachpad ws listandreachpad ws create --name scratcharehide = truein the shipped binary and are in no generated shell completion, so a reader who followed the README and then ranreachpad --helpsaw an unrelated command tree. Replaced with the current verbs.npx @reachpad/cli run scratch -- cargo testaddressed a workspace by its label. There is no name resolution in the CLI, so this fails with "There is no workspace scratch on this account". The example now captures the id.runtime. The snapshot shipsprotoandauthzonly; v1 droppedruntimefrom the CLI's dependencies and the assemble script deliberately does not copy it.Intel Mac install
install.shhad noDarwin/x86_64case, socurl -fsSL https://reachpad.dev/install | shon an Intel Mac hit "reachpad: no prebuilt binary for Darwin/x86_64", whileREADME.mdclaimed the platform and npm shipped@reachpad/cli-darwin-x64for it.Verified before choosing the fix:
release.ymlbuildsx86_64-apple-darwinin its matrix, and cli-v0.4.5 publishesreachpad-x86_64-apple-darwin.tar.gz, whose hash is in that release'sSHA256SUMS(the file the installer verifies against before anything executes). The artifact exists, so the case is added rather than the claim removed. After the change every platform the table maps resolves to an asset the release publishes, and all four published assets are reachable from some case.sh -n install.shpasses; the platform table was exercised for all six plausibleuname -s/uname -mpairs against the liveSHA256SUMS.