Skip to content

docs(install): add uv tool update-shell hint for post-install PATH#394

Merged
memtomem merged 1 commit intomainfrom
docs/install-path-update-shell
Apr 22, 2026
Merged

docs(install): add uv tool update-shell hint for post-install PATH#394
memtomem merged 1 commit intomainfrom
docs/install-path-update-shell

Conversation

@memtomem
Copy link
Copy Markdown
Owner

Summary

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 install writes the mm shim to ~/.local/bin (macOS/Linux default), but that directory isn't on $PATH in a fresh shell profile. uv itself prints a one-line "run uv 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 init right after install) will fail with mm: command not found before the user connects the dots.

Before this PR, a grep across README.md + packages/memtomem/README.md + docs/ for update-shell, command not found, and not on .+PATH returned 0 hits.

The #393 change added mm --version as the verify step, which is exactly the command that surfaces command not found on 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 mm resolves because ~/.local/bin is already on $PATH (prior uv tool install history). Reproducing the command not found path 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-shell is a documented uv command (uv tool update-shell --help).
  • ~/.local/bin is the default XDG_BIN_HOME uv writes to on macOS/Linux.
  • The failure text mm: command not found is the exact shell error a user would see, so it's searchable / skimmable.
  • No lint/test failures expected — docs-only, no code paths touched.
  • Reviewer: render the three pages and check the two blockquotes read well sequentially (cache-lag → PATH).

Scope

Out of scope (separate issues / PRs):

🤖 Generated with Claude Code

@memtomem memtomem changed the base branch from docs/install-refresh-cache-lag to main April 22, 2026 23:39
`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]>
@memtomem memtomem force-pushed the docs/install-path-update-shell branch from d8d8700 to f329dbd Compare April 22, 2026 23:40
@memtomem memtomem merged commit 74e9fbe into main Apr 22, 2026
7 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 22, 2026
@memtomem memtomem deleted the docs/install-path-update-shell branch April 27, 2026 14:56
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs/install: add post-install "which mm" verify and "uv tool update-shell" fallback

2 participants