https://github.com/catppuccin/cli

🪄 Soothing pastel theme manager (WIP)
https://github.com/catppuccin/cli

catppuccin cli golang hacktoberfest meta theme

Last synced: about 2 months ago
JSON representation

🪄 Soothing pastel theme manager (WIP)

• Host: GitHub
• URL: https://github.com/catppuccin/cli
• Owner: catppuccin
• License: mit
• Created: 2022-08-18T18:07:03.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-03T21:08:55.000Z (over 1 year ago)
• Last Synced: 2025-05-10T11:33:50.336Z (5 months ago)
• Topics: catppuccin, cli, golang, hacktoberfest, meta, theme
• Language: Go
• Homepage:
• Size: 29.9 MB
• Stars: 82
• Watchers: 4
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


	


	

	Catppuccin CLI

	





	

	

	









## Catppuccin CLI

A work-in-progress CLI for Catppuccin themes.

It allows you to:

- Install themes with one command

- Uninstall themes with one command

- Update themes with one command

## Installation

- You can download the executable for this project from the releases section. Download the release as per your OS. 

## Development 

- The foremost requirement to develop is to make sure that go version 1.19 is installed. 

- Development and contribution guidelines along with the future development plans have been added to the [wiki](https://github.com/catppuccin/cli/wiki/Contributing).

## Building

You can simply build the cli with `make`. This will automatically install the required dependencies and build the program. The outputed executable will be in `builds/`. You can also use GoReleaser to build it for all platforms.

## Docker image 

- The cli also has a Docker image. To build it, run `docker build --network=host -t ctp:latest .`.

- To run the built image, run the command `docker run -it --rm --net=host ctp:latest help`.

## TODO

- [x] Hooks 

  - [x] Install hooks

  - [x] Uninstall hooks

- [x] Command hooks: To execute shell scripts.  

- [x] Web hooks: To handle `xdg-open`, `open` or equivalent command on Windows. 

- [x] Rework remove function from scratch: Need to find a way to save the flavour user installs. 

- [x] Better error handling overall 

- [x] Use `gofmt` from now on. 

- [x] Rewrite the wiki for catppuccin/cli to make first contributions easier. 

- [x] Refactoring: 

  - [x] Move `cmd` to `internal`

  - [x] Move `main.go` to `cmd/ctp` => Reason: Check [#25](https://github.com/catppuccin/cli/issues/25)

 



	





	Copyright © 2021-present Catppuccin Org