summaryrefslogtreecommitdiff
path: root/README.md
blob: 6609fd6af0e8b6f8907f04b26f187142fd433fb4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# Termpicker

A simple Color Picker Designed for your Terminal

Here is a quick demo of what has been done so far:
<div align="center">
  <img src="./assets/demo.gif" width="600" alt="Termpicker Demo"><br>
</div>

## Features:

- Preview any color using a truecolor terminal
- Create colors using sliders for RGB, HSL, and CMYK
- Seamlessly convert between color formats (RGB, HSL, CMYK) as you create
- Copy the color to your clipboard in various formats ([RGB][4], [HEX][5], [HSL][6], [CMYK][7], [ANSI truecolor][8])

## Usage:

The keybindings are pretty simple and shown in the UI. Their description can
be expanded by pressing the `?` key. The exhaustive list is available if you
RTFM :P (either `termpicker --help` or `man termpicker` if the manpage is
installed)

## Installation

**Via Go**:

```sh
go install github.com/ChausseBenjamin/termpicker@latest
```

**From the aur**:

Termpicker is on the AUR! :tada: Just install it with you favourite
aur package manager (yay, paru, yaourt, etc...)

```sh
yay -S termpicker
```

**Manual Installation**:

Just grab the latest release for your platform and install the binary
somewhere in your `PATH`. Releases also include a manpage which you can
install to your `$XDG_DATA_HOME/man/man1/`.

## Roadmap

- [ ] Publish release to more mainstream repositories (Homebrew, nix, etc...)
- [ ] Unit-test color conversions near edge case colors
- [ ] Migrate to bubbletea/V2 once it comes out of beta
- [ ] Warn the user if the terminal is too small (and refuse to render)

[1]: https://github.com/charmbracelet/lipgloss
[2]: https://github.com/charmbracelet/soft-serve
[3]: https://github.com/charmbracelet/bubbles#help
[4]: https://www.w3schools.com/colors/colors_rgb.asp
[5]: https://www.w3schools.com/colors/colors_hexadecimal.asp
[6]: https://www.w3schools.com/colors/colors_hsl.asp
[7]: https://www.w3schools.com/colors/colors_cmyk.asp
[8]: https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797#rgb-colors