catppuccin_toolbox@catwalk-v1.2.0

Catppuccin Toolbox

Catppuccin’s development tools

A set of software tools by Catppuccin developers, for Catppuccin developers.

Catwalk
Whiskers
Puccinier
InkCat
DocPuccin
Contrast Test
️Nix usage notes

InkCat

InkCat is a minimal and versatile solution for displaying colors from each one of Catppuccin’s flavours in your terminal. This program also allows you to copy them to your clipboard.

Usage:

$ npm install -g @catppuccin/inkcat # Install command
$ inkcat --help
$ npm uninstall -g @catppuccin/inkcat   # Uninstall command

Help info:

Usage:
    #1: inkcat <palette(s)> <color(s)>
    #2: inkcat <flags>

Args:
    <palette(s)>            Palettes separated by commas (e.g. frappe,latte)
    <color(s)>              Colors separated by commas (e.g. peach,rosewater,lavender)

Flags:
    -h,--help               See this help message
    -n,--no-copy            Don't copy the colors to the clipboard
    -f,--format             Specify format (hex, hsl, rgb)

Examples:
    #1: inkcat frappe,latte peach,rosewater,lavender
    #2: inkcat macchiato base,yellow --no-copy
    #3: inkcat mocha
    #4: inkcat mocha maroon --format rgb

DocPuccin

Docpuccin is a small program that fetches health files needed per project type

Usage:

$ npm install -g @catppuccin/docpuccin # Install command
$ docpuccin --help
$ npm uninstall -g @catppuccin/docpuccin # Uninstall command

Help info:

Usage:
    #1: docpuccin <health_file_type> <file(s)>
    #2: docpuccin <flags>

Args:
    <health_file_type>  Check the "Available health files" section
    <file(s)>       Health files to be downloaded. They can be comma separated (e.g. npmrc,npmignore)

Flags:
    -h,--help       See this help message

Examples:
    #1: docpuccin npm npmignore
    #2: docpuccin repo license
    #3: docpuccin any makefile,editorconfig`

To see the available health files please download the tool and run it with the --help flag.

Contrast Test

Test Catppuccin’s flavours compliance with modern web contrast standards

Usage:

$ git clone https://github.com/catppuccin/toolbox.git 
$ cd toolbox/
$ npm ci
$ npm run contrast_test

Nix

With Flakes

Add the following to your flake.nix:

NixOS

{
    inputs = {
        catppuccin-toolbox.url = "github:catppuccin/toolbox";
    };
    outputs = {nixpkgs, catppuccin-toolbox, ...}: {
        nixosConfigurations.HOSTNAME = nixpkgs.lib.nixosSystem {
          modules = [
          {
              environment.systemPackages = [
                catppuccin-toolbox.packages.${pkgs.system}.puccinier
              ];
            }
          ];
        };
      };
    }
}

Home-Manager

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";

    home-manager = {
      url = "github:nix-community/home-manager";
      inputs.nixpkgs.follows = "nixpkgs";
    };

    catppuccin-toolbox.url = "github:catppuccin/toolbox";
  };

  outputs = {nixpkgs, home-manager, catppuccin-toolbox, ...}: {
    homeConfigurations."user@hostname" = home-manager.lib.homeManagerConfiguration {
      pkgs = nixpkgs.legacyPackages.x86_64-linux;

      modules = [
        {        
            home.packages = [
                catppuccin-toolbox.packages.${pkgs.system}.puccinier
            ];
        } 
      ];
    };
  };
}

Without Flakes

Add the following to your configuration:

{config, pkgs, ...}: let
  flake-compat = builtins.fetchTarball "https://github.com/edolstra/flake-compat/archive/master.tar.gz";
  catppuccin-toolbox = (import flake-compat {
    src = builtins.fetchTarball "https://github.com/catppuccin/toolbox/archive/main.tar.gz";
  }).defaultNix;
in {
    # Home Manager
    home.packages = [
        catppuccin-toolbox.packages.${pkgs.system}.puccinier
    ];

    # Nix
    environment.systemPackages = [
        catppuccin-toolbox.packages.${pkgs.system}.puccinier
    ];
}