😸🧰 Toolbox

Catppuccin's developement tools

 

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

 

🪴 Index

• 👷 Palette Builder
• 🟠 Circular Thumbnails Generator
• 🖌️ InkCat
• 🇨 DocPuccin
• 🖼️ Puccinier
• 🎨 Catwalk
• 🌈 Contrast Test
• 😽 Meow

 

 

👷 Palette Builder

Export the colors of every Catppuccin flavour into various formats. Currently it supports:

• CSS
• Json

Usage:

$ git clone https://github.com/catppuccin/toolbox.git && cd toolbox/palette_builder
$ npm install	# fetch dependencies
$ npm start <format> <out_file>

Where:

• <format>: can be json or css +<out_file>: is an optional parameter. In its absence the new format is printed to the console

 

🟠 Circular Thumbnails Generator

Generate circular thumbnails of the palettes

Usage:

$ python3 -m pip install --upgrade pip
$ python3 -m pip install --upgrade Pillow
$ python3 __init__.py <--show>

Where:

• --show: is an optional parameter that displays the PNGs in your device's image previewing software instead saving them into an out/ directory

 

🖌️ 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 && inkcat --help	# Install command
$ npm uninstall -g @catppuccin/inkcat	# Uninstall command

Note: use sudo if needed

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)

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

Testing:

$ npm install	# fetch dependencies
$ make link	# to link the binary locally
$ make unlink	# to unlink the binary

Note: use sudo if needed

 

🇨🇭 DocPuccin

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

Usage:

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

Note: use sudo if needed

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

Exmaples:
	#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.

Testing:

$ git clone https://github.com/catppuccin/toolbox.git && cd toolbox/docpuccin/
$ npm install	# fetch dependencies
$ make link	# to link the binary locally
$ make unlink	# to unlink the binary

Note: use sudo if needed

 

🖼️ Puccinier

This is a small program that helps you generate the rest of the Catppuccin palettes off of a template file written in one of them.

Help info:

Usage:
	#1: ${PROGRAM}  <file(s)> <flags>

Args:
	<file(s)>\tFiles to be converted to other palettes. They can be comma separated (e.g. hello.txt,something.json)

Flags:
	-o,--out\tPalettes to export. One may specify many, just separete them with commas (e.g. --out frappe,latte)
	-s,--source\tSpecify the source palette of the files (if none is given, it will be detected)
	-v,--verbose\tEnables verbosity
	-h,--help\tSee this help message

Exmaples:
	#1: ${PROGRAM} project.json --out frappe
	#2: ${PROGRAM} --out latte,macchiato project.json,hello.txt,some_file
	#3: ${PROGRAM} --source frappe --out mocha --verbose my_file.md`

Usage:

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

Note: use sudo if needed

Testing:

$ git clone https://github.com/catppuccin/toolbox.git && cd toolbox/puccinier/
$ npm install	# fetch dependencies
$ make link	# link the binary locally
$ make unlink	# unlink the binary

Note: use sudo if needed

 

🎨Catwalk

A sweet program that takes in four showcase images and displays them all at once.

Usage:

$ python3 -m pip install --upgrade catppuccin-catwalk
$ catwalk <images>
# if `catwalk` doesn't work for you, please try:
$ python3 -m catwalk

Parameter	Description
images	4 images to merge into one. REQUIRED. All other parameters are optional.
--layout	Choose the style of the showcase image. Available options are composite (default), grid, and stacked.
--gap	Size of the gap between the grid layout. Defaults to 20px.
--background	Places the screenshot on a background colour of your choosing. Provide a hex value like "#89dceb".
--margin	Defines the margin around the screenshot. Defaults to 40px.
--radius	Sets the corner radius for the window. Defaults to 50px.
--outer	Set the radius for the background image. Defaults to the value of --radius.
--shadow	Enables a drop shadow behind the screenshot, and sets and the strength of the blur. Defaults to 12, if no value is passed.
--rainbow	Adds a rainbow background. Will override the --background setting.
--preview	Previews the output with your image viewer, instead of saving it.
--help	A summary of the available parameters.

 

🌈 Contrast Test

Test Catppuccin's flavours compliance with modern web contrast standards

Usage:

$ git clone https://github.com/catppuccin/toolbox.git && cd toolbox/contrast_test/
$ npm install	# fetch dependencies
$ npm start

 

😽 Meow

"Waouh Waouh", said the French Poodle

 

Copyright © 2021-present Catppuccin Org