Add spicetify config instructions to getting started - #194
Conversation
Added instructions for configuring spicetify path based on shell type.
WalkthroughDocumentation update to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/getting-started.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/getting-started.md
99-99: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (1)
docs/getting-started.md (1)
105-117: Content and approach look good.The shell detection approach is standard, and the provided commands are accurate:
- zsh and bash PATH exports use the correct RC file and syntax
- fish uses
fish_add_path, which is the idiomatic way to add to PATH in fish (no manual source needed)The section integrates well with the existing Linux-specific setup documentation.
|
Thanks for the PR! |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/getting-started.md
🔇 Additional comments (1)
docs/getting-started.md (1)
101-103: Code block language identifiers fixed.The previous MD040 linting issue (missing language identifier) has been resolved. All code blocks now have proper language tags (
bashandfish).Also applies to: 110-113, 118-121, 126-128
| <details> | ||
| <summary>Adding Spicetify to PATH</summary> | ||
|
|
||
| If you installed Spicetify via a package manager (Homebrew, AUR, etc.) and the `spicetify` command isn't found, you may need to add it to your PATH manually. | ||
|
|
||
| First, determine your shell: | ||
|
|
||
| ```bash | ||
| echo $SHELL | ||
| ``` | ||
|
|
||
| Then add `~/.spicetify` to your PATH based on your shell: | ||
|
|
||
| <Tabs> | ||
| <TabItem value="zsh" label="zsh" default> | ||
|
|
||
| ```bash | ||
| echo 'export PATH=$PATH:~/.spicetify' >> ~/.zshrc | ||
| source ~/.zshrc | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| <TabItem value="bash" label="bash"> | ||
|
|
||
| ```bash | ||
| echo 'export PATH=$PATH:~/.spicetify' >> ~/.bashrc | ||
| source ~/.bashrc | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| <TabItem value="fish" label="fish"> | ||
|
|
||
| ```fish | ||
| fish_add_path ~/.spicetify | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| </details> |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
cat -n docs/getting-started.md | sed -n '60,135p'Repository: spicetify/docs
Length of output: 1813
🌐 Web query:
Homebrew spicetify-cli installation path
💡 Result:
When installed with Homebrew, spicetify-cli is stored in Homebrew's Cellar and a symlinked executable is placed in Homebrew's bin directory.
Common locations:
- Cellar: $(brew --cellar)/spicetify-cli// (actual binary at .../bin/spicetify). [1]
- Symlinked executable (in your PATH):
- Apple Silicon macOS: /opt/homebrew/bin/spicetify
- Intel macOS (Homebrew default): /usr/local/bin/spicetify
- Linuxbrew: $(brew --prefix)/bin/spicetify. [1][2]
Commands to find the exact paths on your machine:
- Which symlinked executable: which spicetify
- Show Cellar location: brew --cellar spicetify-cli
- List installed files: brew list --verbose spicetify-cli
Sources: Homebrew formula listing for spicetify-cli and Spicetify installation docs. [1][2]
References
[1] Homebrew formula — spicetify-cli.
[2] Spicetify installation docs.
🌐 Web query:
AUR spicetify-cli installation path
💡 Result:
When installed from the AUR, spicetify-cli is placed in /opt/spicetify-cli (binary at /opt/spicetify-cli/spicetify) and a small wrapper is installed at /usr/bin/spicetify. [1][2]
Sources:
[1] AUR PKGBUILD for spicetify-cli (package() installs to /opt/spicetify-cli and creates /usr/bin/spicetify).
[2] Official Spicetify installation docs (AUR instructions / notes about /opt/spotify).
🌐 Web query:
Spicetify shell script installation location
💡 Result:
The official installer places Spicetify in your home directory at ~/.spicetify, with the executable at ~/.spicetify/spicetify. The install script also appends that directory to your shell PATH (or tells you how to). [1][2]
Sources:
[1] Spicetify install.sh (raw).
[2] Spicetify installation docs.
🏁 Script executed:
rg -i "spicetify|PATH" docs/getting-started.md | head -20Repository: spicetify/docs
Length of output: 1373
Clarify which installation methods require manual PATH configuration.
The section's opening line explicitly mentions "if you installed Spicetify via a package manager (Homebrew, AUR, etc.)" but then provides ~/.spicetify as the PATH location, which is incorrect for those methods. Homebrew installs to /usr/local/bin (or $(brew --prefix)/bin on Linuxbrew) and AUR installs a wrapper to /usr/bin—both are in standard system PATH by default. The ~/.spicetify location only applies to shell script installations, which means users installing via Homebrew or AUR who follow these instructions would add a non-existent directory to their PATH and remain stuck with "command not found."
Refactor the section to clarify that this is primarily a fallback for shell script installations, not package manager installations:
-<summary>Adding Spicetify to PATH</summary>
+<summary>Spicetify Command Not Found</summary>
-If you installed Spicetify via a package manager (Homebrew, AUR, etc.) and the `spicetify` command isn't found, you may need to add it to your PATH manually.
+If the `spicetify` command isn't found after installation, you may need to add it to your PATH manually. This is most common with shell script installations; Homebrew and AUR typically handle PATH automatically.🤖 Prompt for AI Agents
In docs/getting-started.md around lines 94 to 133, the guidance wrongly implies
package-manager installs may need ~/.spicetify added to PATH; instead clarify
that package managers (Homebrew, AUR) install spicetify into standard system
locations (e.g., /usr/local/bin, $(brew --prefix)/bin, /usr/bin) and do not
require PATH edits, and change the section to state that adding ~/.spicetify to
PATH is only for manual/shell-script installs; update the opening sentence to
call this a fallback for shell script installs, add a brief note listing the
typical package-manager install paths so readers know they’re already on PATH,
and keep the shell-specific commands as the remedy only for those manual
installs.
Co-authored-by: Afonso Jorge Ramos <afonsojorgeramos@gmail.com>
Added instructions for configuring spicetify path based on shell type.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.