Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 3.21 KB

README.md

File metadata and controls

68 lines (53 loc) · 3.21 KB
Raw

Logo
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.

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

  • Hooks
    • Install hooks
    • Uninstall hooks
  • Command hooks: To execute shell scripts.
  • 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