colo

Command-line tool for displaying colors, written in Rust

Jump to...

• Changelog
• Installation
  • Build from source
• Usage
  • Supported color spaces
  • Specifying hexadecimal colors
  • Color square size
  • Default terminal colors
• Code of Conduct
• Contributing

Changelog

The changelog can be found here.

Note that colo is very young and evolving rapidly. There will likely be big changes in the next releases.

Installation

Installation is explained on the releases page.

Build from source

If you want to build colo from source, make sure you have the Rust toolchain (including Cargo) installed. Then clone this repository and run

fish cargo install --path .

Or, if you don't want to clone the repository, you can run

fish cargo install --git https://github.com/Aloso/colo

This builds the code from the main branch. You can specify a different branch with --branch or a tag with --tag.

Usage

colo recognizes hexadecimal RGB colors as well as HTML color names:

Color spaces other than RGB are supported as well:

If colo is used outside of a terminal, it outputs JSON, because it is the most ubiquitous data exchange format:

Supported color spaces

| Name | Flag | Description | Range of values | |---------|-------|------------------------------------|-----------------| | rgb | R | red, green, blue | 0 to 255 | | cmy | C | cyan, magenta, yellow | 0 to 1 | | cmyk | K | cyan, magenta, yellow, key | 0 to 1 | | hsv | V | hue, saturation, value | hue: 0 to 360, saturation: 0 to 1, value: 0 to 1 | | hsl | L | hue, saturation, light | hue: 0 to 360, saturation: 0 to 1, light: 0 to 1 | | lch | | luminance, chroma, hue | luminance: 0 to 100, chroma: 0 to 100, hue: 0 to 360 | | luv | | CIELUV color (luminance, u, v) | luminance: 0 to 100, u: -134 to 220, v: -140 to 122 | | lab | | CIELAB color (lightness, a, b) | lightness: 0 to 100, a: ??, b: ?? | | hunterlab | | Hunter Lab color (lightness, a, b) | lightness: 0 to 100, a: ??, b: ?? | | xyz | | CIE 1931 XYZ color | ?? | | yxy | | CIE YXY color | ?? |

The input color space can be specified with --in or -i. The output color space can be specified with --out or -o. If no input color space is entered, colo expects a hexadecimal or HTML color.

There are also flags for the most common input color spaces, e.g. colo -i rgb 15/0/255 can be abbreviated as colo -R 15/0/255.

Specifying hexadecimal colors

Hexadecimal colors are a different notation for RGB colors. They can optionally be prefixed with a #, e.g. colo "#F00".

Hexadecimal colors can be specified with varying precision: Each color channel can be between 1 and 8 digits long, for example

Color square size

The color square size can be adjusted with --size or -s:

Default terminal colors

With --terminal or -t, the default terminal colors are printed:

Code of Conduct

Since this program is written in Rust, the Rust code of conduct applies. Please be friendly and treat everyone with respect.

Contributing

I appreciate your help! The easiest way to help is to file bug reports or suggest new features in the issue tracker.

If you want to create a pull request, make sure the following requirements are met:

• The code is documented
• If you add a dependency that includes unsafe code, please explain why it is required
• Please try to keep compile times small, if feasible

Also, to pass continuous integration, the code must

• be properly formatted with cargo fmt
• pass cargo clippy
• compile on the latest stable Rust version
• all tests must succeed

That's it! If you have any questions, feel free to create an issue.