# Command summary * [`lutgen`↴](#lutgen) * [`lutgen generate`↴](#lutgen-generate) * [`lutgen apply`↴](#lutgen-apply) * [`lutgen patch`↴](#lutgen-patch) * [`lutgen palette`↴](#lutgen-palette) * [`lutgen palette names`↴](#lutgen-palette-names) * [`lutgen palette all`↴](#lutgen-palette-all) ## lutgen A blazingly fast interpolated LUT utility for arbitrary and popular color palettes. **Usage**: **`lutgen`** _`COMMAND ...`_ **Available options:** - **`-h`**, **`--help`** — Prints help information - **`-V`**, **`--version`** — Prints version information **Available commands:** - **`generate`**, **`g`** — Generate and save a Hald CLUT to disk. - **`apply`**, **`a`** — Apply a generated or provided Hald CLUT to images. - **`patch`**, **`p`** — Generate a patch for colors inside text files. - **`palette`**, **`P`** — Print palette names and colors **Supported image formats:** **`avif`** **`bmp`** **`dds`** **`exr`** **`ff`** **`gif`** **`hdr`** **`ico`** **`jpg`** **`jpeg`** **`png`** **`pnm`** **`qoi`** **`tga`** **`tiff`** **`webp`** ## lutgen generate Generate and save a Hald CLUT to disk. **Usage**: **`lutgen`** **`generate`** \[**`-o`**=_`PATH`_\] \[**`-p`**=_`PALETTE`_\] (\[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] \[**`-n`**=_`NEAREST`_\] \[**`-P`**\] \[**`-s`**=_`SHAPE`_\] | **`-S`** \[**`-p`**=_`POWER`_\] \[**`-n`**=_`NEAREST`_\] \[**`-P`**\] \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] | **`-G`** \[**`-m`**=_`MEAN`_\] \[**`-s`**=_`STD_DEV`_\] \[**`-i`**=_`ITERS`_\] \[**`-S`**=_`SEED`_\] \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] | **`-N`** \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\]) **`--`** \[_`COLORS`_\]... **Available positional items:** - _`COLORS`_ — Custom colors to use. Combines with a palette if provided. **Available options:** - **`-o`**, **`--output`**=_`PATH`_ — Path to write output to. - **`-p`**, **`--palette`**=_`PALETTE`_ — Builtin or custom palette to use. Custom palettes can be added to `$LUTGEN_DIR` or `/lutgen`. - Linux: `/home/alice/.config/lutgen` - macOS: `/Users/Alice/Library/Application Support/lutgen` - Windows: `C:\Users\Alice\AppData\Roaming\lutgen` Names are case-insensitive and parsed from the file stem, minus any file extensions. For example, `~/.config/lutgen/My-palette.txt` would be avalable to use as `my-palette`. - **`-L`**, **`--lum`**=_`FACTOR`_ — Factor to multiply luminocity values by. Effectively weights the interpolation to prefer more colorful or more greyscale/unsaturated matches. Usually paired with `--preserve`. [default: 1.0] - **`-l`**, **`--level`**=_`2-16`_ — Hald clut level to generate. A level of 16 stores a value for the entire sRGB color space. [default: 10] - **`-n`**, **`--nearest`**=_`NEAREST`_ — Number of nearest colors to consider when interpolating. 0 uses all available colors. [default: 16] - **`-P`**, **`--preserve`** — Preserve the original image's luminocity values after interpolation. [default: false] - **`-s`**, **`--shape`**=_`SHAPE`_ — Shape parameter for the default Gaussian RBF interpolation. Effectively creates more or less blending between colors in the palette, where bigger numbers equal less blending. Effect is heavily dependant on the number of nearest colors used. [default: 128.0] ### **`-S`** \[**`-p`**=_`POWER`_\] \[**`-n`**=_`NEAREST`_\] \[**`-P`**\] \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] - **`-S`**, **`--shepards-method`** — Enable using Shepard's method (Inverse Distance RBF) for interpolation. - **`-p`**, **`--power`**=_`POWER`_ — Power parameter for shepard's method. [default: 4.0] ### **`-G`** \[**`-m`**=_`MEAN`_\] \[**`-s`**=_`STD_DEV`_\] \[**`-i`**=_`ITERS`_\] \[**`-S`**=_`SEED`_\] \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] - **`-G`**, **`--gaussian-sampling`** — Enable using Gaussian sampling for interpolation (slow). - **`-m`**, **`--mean`**=_`MEAN`_ — Average amount of noise to apply in each iteration. [default: 0.0] - **`-s`**, **`--std-dev`**=_`STD_DEV`_ — Standard deviation parameter for the noise applied in each iteration. [default: 20.0] - **`-i`**, **`--iterations`**=_`ITERS`_ — Number of iterations of noise to apply to each pixel. [default: 512] - **`-S`**, **`--seed`**=_`SEED`_ — Seed for noise rng. [default: 42080085] ### **`-N`** \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] - **`-N`**, **`--nearest-neighbor`** — Disable interpolation completely. - **`-h`**, **`--help`** — Prints help information ## lutgen apply Apply a generated or provided Hald CLUT to images. **Usage**: **`lutgen`** **`apply`** \[**`-d`**\] \[**`-o`**=_`PATH`_\] \[**`-p`**=_`PALETTE`_\] \[**`-c`**\] (**`--hald-clut`**=_`FILE`_ | \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] \[**`-n`**=_`NEAREST`_\] \[**`-P`**\] \[**`-s`**=_`SHAPE`_\] | **`-S`** \[**`-p`**=_`POWER`_\] \[**`-n`**=_`NEAREST`_\] \[**`-P`**\] \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] | **`-G`** \[**`-m`**=_`MEAN`_\] \[**`-s`**=_`STD_DEV`_\] \[**`-i`**=_`ITERS`_\] \[**`-S`**=_`SEED`_\] \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] | **`-N`** \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\]) _`IMAGES`_... **`--`** \[_`COLORS`_\]... **Available positional items:** - _`IMAGES`_ — Images to correct, using the generated or provided hald clut. - _`COLORS`_ — Custom colors to use. Combines with a palette if provided. **Available options:** - **`-d`**, **`--dir`** — Always save to a directory when there is only one input file. (matches output behavior for multiple files) - **`-o`**, **`--output`**=_`PATH`_ — Path to write output to. - **`-p`**, **`--palette`**=_`PALETTE`_ — Builtin or custom palette to use. Custom palettes can be added to `$LUTGEN_DIR` or `/lutgen`. - Linux: `/home/alice/.config/lutgen` - macOS: `/Users/Alice/Library/Application Support/lutgen` - Windows: `C:\Users\Alice\AppData\Roaming\lutgen` Names are case-insensitive and parsed from the file stem, minus any file extensions. For example, `~/.config/lutgen/My-palette.txt` would be avalable to use as `my-palette`. - **`-c`**, **`--cache`** — Cache generated LUT. No effect when using an external LUT. - **` --hald-clut`**=_`FILE`_ — External Hald CLUT to use instead of generating one. - **`-L`**, **`--lum`**=_`FACTOR`_ — Factor to multiply luminocity values by. Effectively weights the interpolation to prefer more colorful or more greyscale/unsaturated matches. Usually paired with `--preserve`. [default: 1.0] - **`-l`**, **`--level`**=_`2-16`_ — Hald clut level to generate. A level of 16 stores a value for the entire sRGB color space. [default: 10] - **`-n`**, **`--nearest`**=_`NEAREST`_ — Number of nearest colors to consider when interpolating. 0 uses all available colors. [default: 16] - **`-P`**, **`--preserve`** — Preserve the original image's luminocity values after interpolation. [default: false] - **`-s`**, **`--shape`**=_`SHAPE`_ — Shape parameter for the default Gaussian RBF interpolation. Effectively creates more or less blending between colors in the palette, where bigger numbers equal less blending. Effect is heavily dependant on the number of nearest colors used. [default: 128.0] ### **`-S`** \[**`-p`**=_`POWER`_\] \[**`-n`**=_`NEAREST`_\] \[**`-P`**\] \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] - **`-S`**, **`--shepards-method`** — Enable using Shepard's method (Inverse Distance RBF) for interpolation. - **`-p`**, **`--power`**=_`POWER`_ — Power parameter for shepard's method. [default: 4.0] ### **`-G`** \[**`-m`**=_`MEAN`_\] \[**`-s`**=_`STD_DEV`_\] \[**`-i`**=_`ITERS`_\] \[**`-S`**=_`SEED`_\] \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] - **`-G`**, **`--gaussian-sampling`** — Enable using Gaussian sampling for interpolation (slow). - **`-m`**, **`--mean`**=_`MEAN`_ — Average amount of noise to apply in each iteration. [default: 0.0] - **`-s`**, **`--std-dev`**=_`STD_DEV`_ — Standard deviation parameter for the noise applied in each iteration. [default: 20.0] - **`-i`**, **`--iterations`**=_`ITERS`_ — Number of iterations of noise to apply to each pixel. [default: 512] - **`-S`**, **`--seed`**=_`SEED`_ — Seed for noise rng. [default: 42080085] ### **`-N`** \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] - **`-N`**, **`--nearest-neighbor`** — Disable interpolation completely. - **`-h`**, **`--help`** — Prints help information ## lutgen patch Generate a patch for colors inside text files. **Usage**: **`lutgen`** **`patch`** \[**`-w`**\] \[**`-n`**\] \[**`-p`**=_`PALETTE`_\] (**`--hald-clut`**=_`FILE`_ | \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] \[**`-n`**=_`NEAREST`_\] \[**`-P`**\] \[**`-s`**=_`SHAPE`_\] | **`-S`** \[**`-p`**=_`POWER`_\] \[**`-n`**=_`NEAREST`_\] \[**`-P`**\] \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] | **`-G`** \[**`-m`**=_`MEAN`_\] \[**`-s`**=_`STD_DEV`_\] \[**`-i`**=_`ITERS`_\] \[**`-S`**=_`SEED`_\] \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] | **`-N`** \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\]) _`FILES`_... **`--`** \[_`COLORS`_\]... **Available positional items:** - _`FILES`_ — Text files to generate patches for. - _`COLORS`_ — Custom colors to use. Combines with a palette if provided. **Available options:** - **`-w`**, **`--write`** — Write changes directly to the files. - **`-n`**, **`--no-patch`** — Disable computing and printing the patch. Usually paired with --write. - **`-p`**, **`--palette`**=_`PALETTE`_ — Builtin or custom palette to use. Custom palettes can be added to `$LUTGEN_DIR` or `/lutgen`. - Linux: `/home/alice/.config/lutgen` - macOS: `/Users/Alice/Library/Application Support/lutgen` - Windows: `C:\Users\Alice\AppData\Roaming\lutgen` Names are case-insensitive and parsed from the file stem, minus any file extensions. For example, `~/.config/lutgen/My-palette.txt` would be avalable to use as `my-palette`. - **` --hald-clut`**=_`FILE`_ — External Hald CLUT to use instead of generating one. - **`-L`**, **`--lum`**=_`FACTOR`_ — Factor to multiply luminocity values by. Effectively weights the interpolation to prefer more colorful or more greyscale/unsaturated matches. Usually paired with `--preserve`. [default: 1.0] - **`-l`**, **`--level`**=_`2-16`_ — Hald clut level to generate. A level of 16 stores a value for the entire sRGB color space. [default: 10] - **`-n`**, **`--nearest`**=_`NEAREST`_ — Number of nearest colors to consider when interpolating. 0 uses all available colors. [default: 16] - **`-P`**, **`--preserve`** — Preserve the original image's luminocity values after interpolation. [default: false] - **`-s`**, **`--shape`**=_`SHAPE`_ — Shape parameter for the default Gaussian RBF interpolation. Effectively creates more or less blending between colors in the palette, where bigger numbers equal less blending. Effect is heavily dependant on the number of nearest colors used. [default: 128.0] ### **`-S`** \[**`-p`**=_`POWER`_\] \[**`-n`**=_`NEAREST`_\] \[**`-P`**\] \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] - **`-S`**, **`--shepards-method`** — Enable using Shepard's method (Inverse Distance RBF) for interpolation. - **`-p`**, **`--power`**=_`POWER`_ — Power parameter for shepard's method. [default: 4.0] ### **`-G`** \[**`-m`**=_`MEAN`_\] \[**`-s`**=_`STD_DEV`_\] \[**`-i`**=_`ITERS`_\] \[**`-S`**=_`SEED`_\] \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] - **`-G`**, **`--gaussian-sampling`** — Enable using Gaussian sampling for interpolation (slow). - **`-m`**, **`--mean`**=_`MEAN`_ — Average amount of noise to apply in each iteration. [default: 0.0] - **`-s`**, **`--std-dev`**=_`STD_DEV`_ — Standard deviation parameter for the noise applied in each iteration. [default: 20.0] - **`-i`**, **`--iterations`**=_`ITERS`_ — Number of iterations of noise to apply to each pixel. [default: 512] - **`-S`**, **`--seed`**=_`SEED`_ — Seed for noise rng. [default: 42080085] ### **`-N`** \[**`-L`**=_`FACTOR`_\] \[**`-l`**=_`2-16`_\] - **`-N`**, **`--nearest-neighbor`** — Disable interpolation completely. - **`-h`**, **`--help`** — Prints help information ## lutgen palette Print palette names and colors **Usage**: **`lutgen`** **`palette`** (_`COMMAND ...`_ | _`PALETTE`_...) **Examples:** $ **`lutgen palette all`** $ **`lutgen palette names | grep gruvbox`** $ **`lutgen palette oxocarbon-dark oxocarbon-light`** $ **`lutgen palette carburetor > palette.txt`** **Available positional items:** - _`PALETTE`_ — Builtin or custom palette to use. Custom palettes can be added to `$LUTGEN_DIR` or `/lutgen`. - Linux: `/home/alice/.config/lutgen` - macOS: `/Users/Alice/Library/Application Support/lutgen` - Windows: `C:\Users\Alice\AppData\Roaming\lutgen` Names are case-insensitive and parsed from the file stem, minus any file extensions. For example, `~/.config/lutgen/My-palette.txt` would be avalable to use as `my-palette`. **Available options:** - **`-h`**, **`--help`** — Prints help information **Available commands:** - **`names`** — Print all palette names. Useful for scripting and searching. - **`all`** — Print all palette names and colors. ## lutgen palette names Print all palette names. Useful for scripting and searching. **Usage**: **`lutgen`** **`palette`** **`names`** **Available options:** - **`-h`**, **`--help`** — Prints help information ## lutgen palette all Print all palette names and colors. **Usage**: **`lutgen`** **`palette`** **`all`** **Available options:** - **`-h`**, **`--help`** — Prints help information