cli

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.
• Clone the repository and switch to the dev branch.
• Make all the changes to dev branch. To build the executable run go build -o ctp.

Note

• You need to make sure that you set the environmental variable $ORG_OVERRIDE to catppuccin-rfc or the tool will search for .catppuccin.yaml in the catppuccin organisation which currently doesn't host the yaml files. This is a temporary measure to test the tool during its development.

TODO

• Hooks
• Command hooks
• Web hooks: To handle xdg-open, open or equivalent command on Windows.
• Rework remove function from scratch: Need to find a way to save the flavour user installs.
• Better error handling overall
• Use gofmt from now on.
• Rewrite the wiki for catppuccin/cli to make first contributions easier.
• Refactoring:
  • Move cmd to internal
  • Move main.go to cmd/ctp => Reason: Check #25

 

Copyright © 2021-present Catppuccin Org