wallust-run(1)

NAME
wallust-run - Generate a palette from an image

SYNOPSIS
wallust-run [-a|--alpha] [-b|--backend] [-k|--check-contrast] [-n|--no-cache] [-p|--palette] [--saturation] [-t|--threshold] [--dynamic-threshold] [-w|--overwrite-cache] [--save-scheme] [--print-scheme] [-h|--help] <FILE>

OPTIONS

-a, --alpha <ALPHA>
    Alpha *template variable* value, used only for templating (default is 100)

-b, --backend <BACKEND>
    Choose which backend to use (overwrites config)
    Possible values:

    •   full: Read and return the whole image pixels (more precision, slower)

    •   resized: Resizes the image before parsing, mantaining it's aspect ratio

    •   wal: Uses image magick `convert` to generate the colors, like pywal

    •   thumb: Faster algo hardcoded to 512x512 (no ratio respected)

    •   fastresize: A much faster resize algo that uses SIMD. For some reason it fails on some images where `resized` doesn't, for this reason it doesn't *replace* but rather it's a new option

-k, --check-contrast
    Ensure a readable contrast by checking colors in reference to the background (overwrites config)

-n, --no-cache
    Don't cache the results

-p, --palette <PALETTE>
    Choose which palette to use (overwrites config)
    Possible values:

    •   salience: salience-based histogram palette (default). Perceptual salience picks the most visually prominent colors from the image

    •   ansi: ANSI terminal color palette. Orders colors to follow the classic TTY convention: color0 → black, color1 → red-ish, color2 → green-ish, and so on

    •   kmeans: k-means clustering palette. Groups pixels into clusters in Lab color space and uses the centroids as colors

--saturation <SATURATION>
    Add saturation from 1% to 100% (overwrites config)

-t, --threshold <THRESHOLD>
    Choose a custom threshold, between 1 and 100 (overwrites config)

--dynamic-threshold
    Dynamically changes the threshold to be best fit

-w, --overwrite-cache
    Generates colors even if there is a cache version of it

--save-scheme
    Save the generated scheme inside the colorscheme dir

--print-scheme
    Output the palette from color 0 to 15 separated by a new line. (Useful for scripting)

-h, --help
    Print help (see a summary with '-h')

<FILE>
    Path to the image to use

SEE ALSO
wallust(5), wallust-run(1), wallust-cs(1), wallust-theme(1)

BUGS
https://codeberg.org/explosion-mental/wallust