Skip to content

Commit 7406065

Browse files
authored
docs: add spicetify-nix installation instructions (#197)
1 parent 8bb13a3 commit 7406065

1 file changed

Lines changed: 55 additions & 0 deletions

File tree

docs/getting-started.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,48 @@ brew install spicetify-cli
8484
yay -S spicetify-cli
8585
```
8686

87+
</TabItem>
88+
<TabItem value="nix" label="Nix / NixOS">
89+
90+
For NixOS and Home Manager users, use the [spicetify-nix](https://github.com/Gerg-L/spicetify-nix) flake. It provides declarative configuration and handles Spotify installation automatically.
91+
92+
Add the flake input:
93+
94+
```nix
95+
{
96+
inputs.spicetify-nix.url = "github:Gerg-L/spicetify-nix";
97+
}
98+
```
99+
100+
Then import the module and configure:
101+
102+
```nix
103+
# For NixOS: spicetify-nix.nixosModules.spicetify
104+
# For Home Manager: spicetify-nix.homeManagerModules.spicetify
105+
106+
{ pkgs, inputs, ... }:
107+
let
108+
spicePkgs = inputs.spicetify-nix.legacyPackages.${pkgs.system};
109+
in {
110+
programs.spicetify = {
111+
enable = true;
112+
enabledExtensions = with spicePkgs.extensions; [
113+
adblockify
114+
hidePodcasts
115+
shuffle
116+
];
117+
theme = spicePkgs.themes.catppuccin;
118+
colorScheme = "mocha";
119+
};
120+
}
121+
```
122+
123+
See the [spicetify-nix documentation](https://gerg-l.github.io/spicetify-nix) for full configuration options.
124+
125+
:::note
126+
The module installs Spotify for you. Do not install `pkgs.spotify` separately.
127+
:::
128+
87129
</TabItem>
88130
</Tabs>
89131

@@ -248,6 +290,19 @@ After installing via Homebrew, set the Spotify path:
248290
spicetify config spotify_path "/Applications/Spotify.app/Contents/Resources"
249291
```
250292

293+
</TabItem>
294+
<TabItem value="nix-macos" label="Nix / nix-darwin">
295+
296+
For nix-darwin and Home Manager users on macOS, use the [spicetify-nix](https://github.com/Gerg-L/spicetify-nix) flake:
297+
298+
```nix
299+
{
300+
inputs.spicetify-nix.url = "github:Gerg-L/spicetify-nix";
301+
}
302+
```
303+
304+
Import the module (`spicetify-nix.darwinModules.spicetify` for nix-darwin or `spicetify-nix.homeManagerModules.spicetify` for Home Manager) and configure `programs.spicetify`. See the [Linux Nix tab](#linux) for a configuration example.
305+
251306
</TabItem>
252307
</Tabs>
253308

0 commit comments

Comments
 (0)