## Previews
๐ป Latte๐ชด Frappรฉ๐บ Macchiato๐ฟ Mocha
## Usage
You will probably want to see our [Getting started guide](http://nix.catppuccin.com/getting-started/index.html), but as a TLDR:
1. Import the [NixOS](https://nixos.org) and [home-manager](https://github.com/nix-community/home-manager) modules
With Flakes
```nix
{
inputs = {
nixpkgs.url = "nixpkgs/nixos-unstable";
catppuccin.url = "github:catppuccin/nix";
home-manager = {
url = "github:nix-community/home-manager";
inputs.nixpkgs.follows = "nixpkgs";
};
};
outputs = { nixpkgs, catppuccin, home-manager }: {
# for nixos module home-manager installations
nixosConfigurations.pepperjacksComputer = pkgs.lib.nixosSystem {
system = "x86_64-linux";
modules = [
catppuccin.nixosModules.catppuccin
# if you use home-manager
home-manager.nixosModules.home-manager
{
# if you use home-manager
home-manager.users.pepperjack = {
imports = [
./home.nix
catppuccin.homeManagerModules.catppuccin
];
};
}
];
};
# for standalone home-manager installations
homeConfigurations.pepperjack = home-manager.lib.homeManagerConfiguration {
pkgs = nixpkgs.legacyPackages.x86_64-linux;
modules = [
./home.nix
catppuccin.homeManagerModules.catppuccin
];
};
};
}
```
With Nix Channels
```bash
sudo nix-channel --add https://github.com/nix-community/home-manager/archive/master.tar.gz home-manager
sudo nix-channel --add https://github.com/catppuccin/nix/archive/main.tar.gz catppuccin
sudo nix-channel --update
```
For [NixOS module installations](https://nix-community.github.io/home-manager/index.html#sec-install-nixos-module):
```nix
{
imports = [
# if you use home-manager
];
# if you use home-manager
home-manager.users.pepperjack = {
imports = [
];
};
}
```
For [standalone installations](https://nix-community.github.io/home-manager/index.html#sec-install-standalone)
```nix
{
imports = [
];
home.username = "pepperjack";
programs.home-manager.enable = true;
}
```
2. Choose your desired flavor with `catppuccin.flavor`
```nix
{
catppuccin.flavor = "mocha";
}
```
3. Enable for supported programs with `catppucin.enable = true;`
```nix
{
programs.starship = {
enable = true;
catppuccin.enable = true;
};
}
```
4. Enable for all available programs you're using!
```nix
{
catppuccin.enable = true;
}
```
## ๐ FAQ
- Q: **"How do I know what programs are supported?"**\
A: You can find programs supported through home-manager [here](https://nix.catppuccin.com/options/home-manager-options.html),
and NixOS modules [here](https://nix.catppuccin.com/options/nixos-options.html)
- Q: **"How do I set `catppuccin.enable` for everything I use?"**\
A: You can set `catppuccin.enable` [globally](options/nixos-options.md#catppuccinenable)
- Q: **"What versions of NixOS and home-manager are supported?"**\
A: We primarily support the `unstable` branch, but try our best to support the current stable release.
You can check if your stable release is currently supported at [status.nixos.org](https://status.nixos.org/)
## ๐ Thanks to
- [Stonks3141](https://github.com/Stonks3141)
- [getchoo](https://github.com/getchoo)
Catppuccin for Nix
