🧰 Catppuccin's development tools

Overview

😸 🧰 Toolbox

Catppuccin's developement tools

Stars Issues Repo Size

 

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

 

🪴 Index

 

 

👷 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
$ 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

 

🌈 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

Comments
  • Puccinier-V2: Move to toolbox

    Puccinier-V2: Move to toolbox

    Description

    Ports puccinier v2 to the toolbox repository

    Blockers

    • [x] Waiting on licenses to comply with catppuccin organisation guidelines

    Resolves #1

    Resolves #3

    opened by sgoudham 2
  • fix: alpha_fit typo (line 48)

    fix: alpha_fit typo (line 48)

    lowercase "tuple" in line 48 causes TypeError: 'type' object is not subscriptable; fix is to capitalise "T"

    I'm not a Python person, but this fixed an issue I was having with Catwalk. Judging by the syntax of the rest of the file, this looks sensical though.

    opened by sacerd-OS 1
  • Palette Builder usage instructions do not work

    Palette Builder usage instructions do not work

    npm install fails with the following error:

    npm ERR! code ENOENT
    npm ERR! syscall open
    npm ERR! path /home/DIRECTORY/toolbox/package.json
    npm ERR! errno -2
    npm ERR! enoent ENOENT: no such file or directory, open '/home/DIRECTORY/toolbox/package.json'
    npm ERR! enoent This is related to npm not being able to find a file.
    npm ERR! enoent 
    

    This is due to the main directory not having a package.json. It can be avoided by navigating to the palette builder directory before running npm install.

    opened by ap-1 1
  • Puccinier is case sensitive

    Puccinier is case sensitive

    I've just spent 10 minutes trying to figure out why I couldn't convert a theme with puccinier. Turns out that it is case sensitive. For someone that likes their Hexcodes in uppercase, this is a bummer. I would assume that this isn't intended behaviour?

    bug 
    opened by andreasgrafen 0
  • Distribution of Software via Packagemanagers

    Distribution of Software via Packagemanagers

    Just an idea, and maybe I've missed a previous discussion about this, but is distribution via package managers (like homebrew) considered?

    Maintaining individual tools is probably a real pain in the butt, so maybe it could just be a collection for all tools?

    opened by andreasgrafen 0
  • Improvement for Puccinier: Make it convert the name of flavours.

    Improvement for Puccinier: Make it convert the name of flavours.

    All I'm proposing is a tiny improvement for puccinier that converts "Mocha" and other variants (lowercase, catppuccin-mocha etc) to the name of the flavours you're pucciniering to. This would be useful for converting metadata where you would otherwise have to go through all the flavours and convert it yourself. Thoughts?

    opened by Sourcastic 0
  • Catwalk: Side-by-Side Grid Layout request.

    Catwalk: Side-by-Side Grid Layout request.

    So that instead of (2x2)

    A  B
    A  B
    
    C  D
    C  D
    

    It would be (4x1)

    A B C D
    A B C D
    

    This would work really well with mobile screenshots, as currently catwalk isn't ideal for mobile screenshots.

    enhancement 
    opened by isabelincorp 1
  • Puccinier: not generating from lower 32 bits format

    Puccinier: not generating from lower 32 bits format

    I'm trying to use this color palette in flutter.

    when I run puccinier to auto generate color files, all the file is identical.

    so I find out that the supported format is different.

    flutter declares color differently unlike regular hex format like #f5e0dc.

    instead it has extra 0xff before the hex.

    Color(0xfff5e0dc);
    

    so I try to edit the regex myself and only got it to match but I can't make it replace the characters.

    is there a way to make this format supported?

    opened by phdhary 0
  • New Tool/Puccinier: Detect non-Catppuccin colours

    New Tool/Puccinier: Detect non-Catppuccin colours

    To aid with creating themes, it would be useful to have a tool that detects non-Catppuccin colours.

    • Show the line and line number containing the detected colours.
    • Optionally suggest the closest colour in each variant?

    This could either be added to puccinier, or made into a separate tool.

    opened by Gingeh 1
Owner
Catppuccin
Soothing pastel theme for the high-spirited!
Catppuccin
Yeoman - a set of tools for automating development workflow

Welcome, Friend! Yeoman is a robust and opinionated set of tools, libraries, and a workflow that can help developers quickly build beautiful, compelli

Yeoman 9.9k Jan 4, 2023
A frontend framework containing of tools for fast development of dashboard, panel, etc.

Khaos-Admin A frontend framework containing of tools for fast development of dashboard, panel, etc. Tools We Provide Fast Development: We handle data

Hamrah Mechanic 7 Nov 27, 2022
Shield is a development framework for circom developers. The core reason is to provide libraries, plugins, and testing tools to ensure code quality and security.

SHIELD Shield is a development framework for circom developers but we plan it to other languages such as CAIRO, SNARKYJS etc. The core reason is to pr

Xord 41 Dec 22, 2022
Webpack dev tools to make performance analysis, error investigation and loader development more convenient

build-tool-inspector Introduction Webpack dev tools to make performance analysis, error investigation and loader development more convenient. Provide

Modern JS 25 Nov 17, 2022
Dynamic-web-development - Dynamic web development used CSS and HTML

Dynamic-web-development ASSISNMENT I just used CSS and HTML to make a mobile int

null 1 Feb 8, 2022
The project integrates workflow engine, report engine and organization authority management background, which can be applied to the development of OA, HR, CRM, PM and other systems. With tlv8 IDE, business system development, testing and deployment can be realized quickly.

介绍 项目集成了工作流引擎、报表引擎和组织机构权限管理后台,可以应用于OA、HR、CRM、PM等系统开发。配合使用tlv8 ide可以快速实现业务系统开发、测试、部署。 后台采用Spring MVC架构简单方便,前端使用流行的layui界面美观大方。 采用组件开发技术,提高系统的灵活性和可扩展性;采

Qian Chen 38 Dec 27, 2022
tools and plugins for logseq

logtools tools and plugins for logseq logtools-css-productivitypack my css mods for Kanban/columns view (#.v-kanban), Einsihower Matrix (#.v-einsenhow

null 126 Jan 2, 2023
Client-Side Prototype Pollution Tools

Client-Side Prototype Pollution Tools Match rules for Burp Software Version Reporter extension Match rules that passively detect vulnerable libraries

Sergey Bobrov 73 Oct 4, 2022
Tools for the openHAB JavaScript Automation Add-On.

openHAB JS Automation Tools This library provides some utilites for the openHAB JS Scripting Add-On. The JavaScript Add-On is using the NodeJS version

Florian Hotze 4 Oct 18, 2022
Components and tools for building DeFi dapps on Solana + Anchor. Public domain license.

Solana DeFi Framework Components and tools for building DeFi dapps on Solana + Anchor. Public domain license. Status Pre-pre-pre-alpha. Contributing A

null 4 Mar 28, 2022
Annotation tools for the web. Select text, images, or (nearly) anything else, and add your notes.

Annotator Annotator is a JavaScript library for building annotation applications in browsers. It provides a set of interoperable tools for annotating

Open Annotation 2.6k Dec 23, 2022
Tools to help you improve performance of your Vue application.

Why did you update Tools to help you improve performance of your Vue application. Usage If we want to know how many times that (one of or all of) watc

快手“探索组”前端 19 Nov 3, 2022
@nodesecure/ci brings together a set of tools to identify dependencies vulnerabilities and track most common malicious code and patterns

NodeSecure CI Action @nodesecure/ci brings together a set of tools to identify dependencies vulnerabilities and track most common malicious code and p

null 7 Jul 29, 2022
📄 UI clone from vercel old site (Using basic tools)

vercel old site A portfolio site, made using the latest technologies. In the construction of the site using Sass. Quality: 1) Benchmark test using a s

Pedromdsn 2 Mar 1, 2022
Different set of tools with the Polkadot API.

xcmTools Different set of tools with the Polkadot API. Use at your own risk! Getting Started Install packages: yarn Then, run script with ts-node dep

null 12 Dec 15, 2022
Code Scanning/SAST/Static Analysis/Linting using many tools/Scanners with One Report - Scanmycode Community Edition (CE)

Star it If you like it, please give it a GitHub star/fork/contribute. This will ensure continous development ⭐ TLDR; To install it. Install docker and

Marcin Kozlowski 351 Dec 29, 2022
Tools for Dump NUXT JS Environment Config Through Browser Window Object

Introduction Nuxt JS is an open source javascript framework making web development simple and powerful. This tool is used to get environment configura

Agus Setya R 7 Sep 5, 2022
🎨ansi escape code generator to help make colorful command line tools

ansicodes ?? ansi escape code generator to help make colorful command line tools i got tired of looking up ansi code tables when writing command line

Gabe Banks 53 Dec 17, 2022