https://github.com/Kaesebrot84/iris

A cli tool that creates color palettes from images using the median cut algorithm.
https://github.com/Kaesebrot84/iris

cli image-processing rust

Last synced: 2 months ago
JSON representation

A cli tool that creates color palettes from images using the median cut algorithm.

• Host: GitHub
• URL: https://github.com/Kaesebrot84/iris
• Owner: Kaesebrot84
• License: mit
• Created: 2022-04-09T16:25:32.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-02T17:06:23.000Z (almost 2 years ago)
• Last Synced: 2024-07-17T14:18:00.953Z (3 months ago)
• Topics: cli, image-processing, rust
• Language: Rust
• Homepage: https://crates.io/crates/cliris
• Size: 996 KB
• Stars: 43
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Iris

[![Rust](https://github.com/Kaesebrot84/iris/actions/workflows/Build.yml/badge.svg)](https://github.com/Kaesebrot84/iris/actions/workflows/Build.yml)

[![crates.io](https://img.shields.io/crates/v/iris-lib.svg)](https://crates.io/crates/cliris)

A command line tool that creates color palettes from images using the [median

cut algorithm](https://en.wikipedia.org/wiki/Median_cut).

## Usage

```sh

$ cliris --help

cliris 0.2.0

Andrej G. 

A cli tool that creates color palettes from images using the median cut algorithm.

USAGE:

    cliris [OPTIONS] --file-name  [OUTPUT_FORMAT]

ARGS:

        Desired data file format to be written [default: none] [possible values:

                       none, html, json, csv]

OPTIONS:

    -f, --file-name           Target image file name

    -h, --help                           Print help information

    -i, --iterations         Number of iterations [default: 1]

    -o, --out-filename     File path the file should be written to [default: palette]

    -V, --version                        Print version information

```

### Installation

```bash

cargo install cliris

```

### Example

```sh

$ cliris -f peppers.png -i 3 html

Generating palette...

Finished generating palette in 75 ms.

{ R: 191, G: 207, B: 141, A: 255 }

{ R: 139, G: 187, B: 108, A: 255 }

{ R: 171, G: 185, B: 76, A: 255 }

{ R: 118, G: 159, B: 71, A: 255 }

{ R: 197, G: 60, B: 50, A: 255 }

{ R: 186, G: 41, B: 34, A: 255 }

{ R: 117, G: 77, B: 45, A: 255 }

{ R: 78, G: 7, B: 6, A: 255 }

```



    



### Library

This project uses the [iris-lib](https://crates.io/crates/iris-lib) crate, which performs this algorithm as a stand-alone library.