Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sdushantha/farge

Click on a pixel on your screen and show its color value
https://github.com/sdushantha/farge

bash color colorpicker commandline linux wayland x11

Last synced: 2 days ago
JSON representation

Click on a pixel on your screen and show its color value

Host: GitHub
URL: https://github.com/sdushantha/farge
Owner: sdushantha
License: mit
Created: 2019-07-23T11:00:02.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-05-10T09:44:31.000Z (8 months ago)
Last Synced: 2024-12-14T01:08:46.879Z (9 days ago)
Topics: bash, color, colorpicker, commandline, linux, wayland, x11
Language: Shell
Homepage:
Size: 20.6 MB
Stars: 482
Watchers: 5
Forks: 17
Open Issues: 3
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

_{✨ Click on a pixel on your screen and show its color value ✨}

```farge``` is a command line tool which you can use to select a pixel
on the screen and get the value of its color, in either **hex or RGB** format.
The color code is automatically **saved to the clipboard**. If you want to save the color,
```farge``` is able to show the color in a image viewer with the color code on
it. This tool is able to work with a variety of image viewers like ```feh```,
```mpv```, ```nsxiv``` and ```sxiv```. It works on **X11 and Wayland**.

## Dependencies
- ```bash```
- ```bc```
- ```imagemagick```
- ```feh``` (Other: ```mpv```, ```nsxiv``` or ```sxiv```, but you must specify it using the ```--image-viewer``` flag)
#### If you use X11
- ```xcolor``` (https://github.com/Soft/xcolor)
#### If you use Wayland
- ```slurp``` (https://wayland.emersion.fr/slurp)
- ```grim``` (https://wayland.emersion.fr/grim)
- ```wl-copy``` (https://github.com/bugaevc/wl-clipboard)

## Installation

### Install as a package
```farge``` is available in the [Arch User Repository](https://aur.archlinux.org/packages/farge-git). If you use Arch or an Arch-based distro, you can use ```makepkg``` or your AUR helper of choice to install the ```farge-git``` package.

### Install using ```make```
```bash
# Clone the repo
$ git clone https://github.com/sdushantha/farge

# Change your current directory to farge
$ cd farge

# Install it
$ sudo make install
```

### Install it locally

```bash
# Download the farge source code, save it as farge
# and make it executeable
$ curl -L https://git.io/raw-farge > farge && chmod +x farge

# Then move farge to somewhere in your $PATH
# Here is an example
$ mv farge ~/scripts/
```

## Usage
```bash
$ farge --help
usage: farge [OPTIONS...]

┌─┐┌─┐┬─┐┌─┐┌─┐
├┤ ├─┤├┬┘│ ┬├┤
┴ ┴ ┴┴└─└─┘└─┘
Click on a pixel on your screen and show its color value

optional arguments:
--help show this help message and exit
--no-preview dont show the selected color in a preview window
--no-color-code dont write the color code on the preview window
--rgb show the color code as RGB instead of HEX
--image-viewer image viewer to use to show the preview (feh, mpv, nsxiv, sxiv)
--notify send the color code as notification, where the icon is the selected color
--expire-time amount of time the notification should be visible, in milliseconds
--stdout output the color value to stdout
--version show the version of farge you are using
```

## Tips
It would be smart to bind `farge` to a keybinding. Here is an example for `i3wm` users:
```
bindsym $mod+Shift+f --release exec farge
```

If you use a window manager, you can assign rules the windows so they are
always floating. For `i3wm` user, put this in your config:

```
# Let the windows created by Farge be floating
for_window [instance="Farge"] floating enable
```

## License
MIT License