Skip to content

docs(install): explain shell PATH activation - #3903

Merged
rxri merged 1 commit into
spicetify:mainfrom
yassinsolim:fix/install-shell-path-guidance
Aug 25, 2026
Merged

docs(install): explain shell PATH activation#3903
rxri merged 1 commit into
spicetify:mainfrom
yassinsolim:fix/install-shell-path-guidance

Conversation

@yassinsolim

@yassinsolim yassinsolim commented Aug 6, 2026

Copy link
Copy Markdown

Summary

  • tell shell-installer users to open a new terminal or reload their shell profile before using spicetify
  • print the profile path selected by the installer, including custom ZDOTDIR locations
  • keep the manual-PATH fallback accurate for unsupported shells

Why

The shell installer updates a startup file, but when invoked through curl | sh it cannot update the already-running parent shell. The existing completion message immediately suggests running spicetify --help, which results in command not found until the user opens a new terminal or reloads the profile.

Windows is unaffected: install.ps1 updates $env:PATH in the current PowerShell process as well as the persistent user PATH.

Verification

  • sh -n install.sh
  • controlled installer smoke tests for zsh with a custom ZDOTDIR, bash, and fish
  • Marketplace subprocess smoke test confirming the installer's exported PATH still resolves spicetify

Summary by CodeRabbit

  • Bug Fixes
    • Improved installation completion guidance based on whether a shell profile is detected.
    • Added profile reload instructions when applicable.
    • Provided PATH setup instructions when no usable shell profile is available.

@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The installer now provides conditional completion guidance. It gives shell profile reload instructions when a valid profile exists. Otherwise, it gives PATH setup instructions.

Changes

Installation guidance

Layer / File(s) Summary
Conditional post-install instructions
install.sh
The completion message checks for an identified shell profile. It provides reload and spicetify --help instructions when available, or PATH setup guidance otherwise.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: rxri

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the main change: explaining shell PATH activation after installation. The docs scope is slightly imprecise because the change is in install.sh, but the title remains d…
Full details: Title check

Explanation

The title clearly identifies the main change: explaining shell PATH activation after installation. The docs scope is slightly imprecise because the change is in install.sh, but the title remains directly related and specific.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@yassinsolim

yassinsolim commented Aug 6, 2026

Copy link
Copy Markdown
Author

Hi @rxri, CodeRabbit suggested you as the reviewer for this small installer UX fix. When you have a chance, would you mind taking a look? Thanks!

@rxri rxri changed the title fix(install): explain shell PATH activation docs(install): explain shell PATH activation Aug 25, 2026
@rxri
rxri merged commit aecc166 into spicetify:main Aug 25, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants