Skip to content

Add spicetify config instructions to getting started - #194

Merged
afonsojramos merged 2 commits into
mainfrom
unknown repository
Dec 29, 2025
Merged

Add spicetify config instructions to getting started#194
afonsojramos merged 2 commits into
mainfrom
unknown repository

Conversation

@ghost

@ghost ghost commented Dec 23, 2025

Copy link
Copy Markdown

Added instructions for configuring spicetify path based on shell type.

Summary by CodeRabbit

  • Documentation
    • Added Linux-specific guidance that introduces an "Adding to PATH" section with shell-detection and step‑by‑step commands for zsh, bash, and fish to append and source shell RC files. This guidance is presented in tabs and sits alongside the existing Spotify from AUR notes, making manual PATH configuration clearer for Linux users.

✏️ Tip: You can customize this high-level summary in your review settings.

Added instructions for configuring spicetify path based on shell type.
@coderabbitai

coderabbitai Bot commented Dec 23, 2025

Copy link
Copy Markdown

Walkthrough

Documentation update to docs/getting-started.md adds new Linux setup guidance for configuring spicetify PATH in shell RC files (bash, zsh, fish) with shell-detection instructions and sourcing steps.

Changes

Cohort / File(s) Summary
Linux Setup Documentation
docs/getting-started.md
Added new "Setting spicetify config to path" details section in two locations under Linux-specific setup; includes shell-detect guidance and commands to append Spotify path to shell RC files for zsh, bash, and fish; added sourcing instructions for updated RC files

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A path through the Linux maze we trace,
With bash and zsh in perfect place,
Fish swimming swift in config streams,
Your spicetify now gleams and beams! 🎵

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title describes adding spicetify configuration instructions, but the actual change focuses specifically on adding PATH setup guidance for multiple shells, which is a narrower and more technical aspect than general 'config instructions' suggests.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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 and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6e43c7d and b4f4318.

📒 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.

@afonsojramos

Copy link
Copy Markdown
Member

Thanks for the PR!

@afonsojramos
afonsojramos merged commit 8bb13a3 into spicetify:main Dec 29, 2025
1 check was pending

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b4f4318 and 9a9ed18.

📒 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 (bash and fish).

Also applies to: 110-113, 118-121, 126-128

Comment thread docs/getting-started.md
Comment on lines +94 to +133
<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>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 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 -20

Repository: 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.

afonsojramos added a commit that referenced this pull request Apr 21, 2026
Co-authored-by: Afonso Jorge Ramos <afonsojorgeramos@gmail.com>
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.

1 participant