docs(install): add uv tool update-shell hint for post-install PATH#394
Merged
docs(install): add uv tool update-shell hint for post-install PATH#394
uv tool update-shell hint for post-install PATH#394Conversation
`uv tool install` drops the `mm` shim into `~/.local/bin`, which isn't on `$PATH` in a fresh shell profile on macOS / Linux. First-time users running `mm init` right after install see `mm: command not found` with no in-docs signal pointing at `uv tool update-shell`. Neither the verify step (`which mm`) nor the remediation was mentioned anywhere in the public docs. Add a second blockquote after the cache-lag one (stacked on #393) that surfaces the `command not found` failure text as a trigger phrase and points at `uv tool update-shell` + "open a new shell" as the fix. Closes #392. Co-Authored-By: Claude <[email protected]>
d8d8700 to
f329dbd
Compare
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
mm --versionverify +--refreshhint for PyPI cache lag #393) in all three first-touch docs that surfaces themm: command not foundfailure text and points atuv tool update-shellas the fix.Stacked on #393 — base branch is
docs/install-refresh-cache-lag. Merge #393 first, then retarget or rebase this onto main.Closes #392.
Why
uv tool installwrites themmshim to~/.local/bin(macOS/Linux default), but that directory isn't on$PATHin a fresh shell profile.uvitself prints a one-line "runuv tool update-shell" hint on the first-ever tool install, but it's easy to scroll past, and the wizard flow the docs lead into (mm initright after install) will fail withmm: command not foundbefore the user connects the dots.Before this PR, a grep across
README.md+packages/memtomem/README.md+docs/forupdate-shell,command not found, andnot on .+PATHreturned 0 hits.The #393 change added
mm --versionas the verify step, which is exactly the command that surfacescommand not foundon a broken PATH — so this blockquote is the natural extension of that verify step for the failure case.Reproducibility note
On this author's machine,
which mmresolves because~/.local/binis already on$PATH(prioruv tool installhistory). Reproducing thecommand not foundpath requires a shell profile without~/.local/bin, which is the default on macOS; I've left a live-repro out of scope for this session. Evidence is the docs gap (0 mentions, verified above) and the well-known uv behavior on fresh profiles.Test plan
uv tool update-shellis a documenteduvcommand (uv tool update-shell --help).~/.local/binis the defaultXDG_BIN_HOMEuv writes to on macOS/Linux.mm: command not foundis the exact shell error a user would see, so it's searchable / skimmable.Scope
Out of scope (separate issues / PRs):
mm --versionverify +--refreshhint for PyPI cache lag #393 (stacked base).[all]extras primary-install choice — docs/install: primary install command omits [all] extras — decide include vs justify #391.🤖 Generated with Claude Code