wallust-run(1)

📦 version 3.5.2, in nixos 26.05, nixpkgs unstable

✨ wallust-run(1) ✨

okay so bestie, welcome to the wallust-run glow-up 💅 — this is the General Commands Manual page for the little tool that generates a whole palette from an image 🎨🦋. yes. one image in, a whole aesthetic out. iconic behaviour honestly.

🌸 NAME 🌸

wallust-run — generate a palette from an image 🖼️✨

🎀 SYNOPSIS 🎀

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

like yes, that's a lot of flags, but we're gonna go through every single one together, hand in hand 🫶

💜 OPTIONS 💜

  • -a, --alpha <ALPHA> — this one is the alpha template variable value, and lowkey it's only used for templating (nothing else, no cap). default is 100 ✨
  • -b, --backend <BACKEND> — picks which backend gets the job done (and yeah, it overwrites config). the possible values are:
    • full — reads and returns the whole image pixels. more precision, but slower 😭 (you get what you pay for bestie)
    • 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, and for this reason it doesn't replace it, it's just a new option 💀
    • kmeans — Kmeans is an algo that divides and picks pixels all around the image, giving a more diverse look 🌈
  • -c, --colorspace <COLORSPACE> — choose which colorspace to use (overwrites config 🫶). possible values:
    • lab — uses Cie L*a*b color space 🧪
    • labmixed — variant of lab that mixes the colors gathered, and if there aren't enough colors it fallbacks to usual lab (not recommended in small images ⚠️)
    • lch — CIE Lch, and you can understand this color space like LAB but with chrome and hue added. could help when sorting 🎀
    • lchmixed — CIE Lch variant that mixed on every similar color 💜
    • salience — differentiates colors by visual salience. salience refers to how much something (a color) pops out from a context (the background). currently based on CIE Lch 👀
    • lchansi — variant of Lch which preserves 8 colors: black, red, green, yellow, blue, magenta, cyan and gray. this works best with the darkansi palette, allowing a constant color order 🌟
  • -f, --fallback-generator <FALLBACK_GENERATOR> — choose which fallback generation method to use (overwrites config). possible values:
    • interpolate — uses [interpolate] 🌸
    • complementary — uses [complementary] 💫
  • -k, --check-contrast — ensures a readable contrast by checking colors in reference to the background (overwrites config). accessibility slay 💅
  • -n, --no-cache — don't cache the results 🚫🗄️
  • -p, --palette <PALETTE> — choose which palette to use (overwrites config). and bestie, this list is LONG, buckle up 🎢:
    • dark — 8 dark colors, dark background and light contrast 🌑
    • dark16 — same as dark but uses the 16 colors trick ✨
    • darkcomp — this is a dark variant that changes all colors to it's complementary counterpart, giving the feeling of a 'new palette' but that still makes sense with the image provided 🎨
    • darkcomp16 — 16 variation of the dark complementary variant 💫
    • ansidark — this is not a 'dark' variant, it's a new palette meant to work with lchansi colorspace, which will maintain 'tty' like color order and only adjusting the colors acording to the theme. a possible solution for LS_COLORS and the like. should workout with other colorspace, but the result may not be optimal 👑
    • ansidark16 — the ansidark palette with 16 color variation 🔥
    • harddark — same as dark with hard hue colors 💥
    • harddark16 — harddark with 16 color variation 🧨
    • harddarkcomp — complementary colors variation of harddark scheme 🔄
    • harddarkcomp16 — complementary colors variation of harddark scheme (the 16 one) 🔁
    • saliencedark — dark with ascending salience, sampling the highest (default) gathered salient colors ⬆️
    • saliencedark16 — SalienceDark but uses the 16 colors trick 🎀
    • saliencedarkbalanced — SalienceDark, but sampling the median gathered salient colors. use if you find all the colors screaming your attention (all very salient) and you want to tone it down 😌
    • saliencedarkbalanced16 — SalienceDarkBalanced but uses the 16 colors trick 🩷
    • saliencedarkdistributed — SalienceDark, but sampling distributed across gathered salient colors. use if you find all colors screaming your attention (all very salient) and you want to spread it out 🌈
    • saliencedarkdistributed16 — SalienceDarkDistributed but uses the 16 colors trick 🦋
    • saliencedarklow — SalienceDark, but sampling the lowest gathered salient colors. use if you find all colors screaming your attention (all very salient) and you really want to tone it down 🤫
    • saliencedarklow16 — SalienceDarkLow but uses the 16 colors trick 🌙
    • light — light bg, dark fg ☀️
    • light16 — same as light but uses the 16 color trick ✨
    • lightcomp — complementary colors variation of light 🔆
    • lightcomp16 — complementary colors variation of light with the 16 color variation 💛
    • softdark — variant of softlight, uses the lightest colors and a dark background (could be interpreted as dark inversed) 🍓
    • softdark16 — softdark with 16 color variation 🍰
    • softdarkcomp — complementary variation for softdark 💐
    • softdarkcomp16 — complementary variation for softdark with the 16 color variation 🌷
    • softlight — light with soft pastel colors, counterpart of harddark 🧁
    • softlight16 — softlight with 16 color variation 🎂
    • softlightcomp — softlight with complementary colors 💝
    • softlightcomp16 — softlight with complementary colors with 16 colors 🎁
    • saliencelight — light with ascending salience, sampling the highest (default) gathered salient colors ⭐
    • saliencelight16 — SalienceLight but uses the 16 colors trick 🌟
    • saliencelightbalanced — SalienceLight, but sampling the median gathered salient colors. use if you find all the colors screaming your attention (all very salient) and you want to tone it down 😮‍💨
    • saliencelightbalanced16 — SalienceLightBalanced but uses the 16 colors trick 🫧
    • saliencelightdistributed — SalienceLight, but sampling distributed across gathered salient colors. use if you find all colors screaming your attention (all very salient) and you want to spread it out 🪩
    • saliencelightdistributed16 — SalienceLightDistributed but uses the 16 colors trick 🎊
    • saliencelightlow — SalienceLight, but sampling the lowest gathered salient colors. use if you find all colors screaming your attention (all very salient) and you really want to tone it down 🤐
    • saliencelightlow16 — SalienceLightLow but uses the 16 colors trick 🌛
  • --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 — saves the generated scheme inside the colorscheme dir 💾
  • --print-scheme — outputs 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 you wanna use 🖼️🫶

🦋 SEE ALSO 🦋

wallust(5), wallust-run(1), wallust-cs(1), wallust-theme(1), wallust-themes<sup>1</sup> — go read those too bestie, they're the whole friend group 👯‍♀️

📝 NOTES 📝

  1. suggestions for new colorschemes returned by the themes subcommand should be filled here. 👉 https://codeberg.org/explosion-mental/wallust-themes

💀 BUGS 💀

https://codeberg.org/explosion-mental/wallust — that's where the bugs live, go report 'em 🐛🔗

that's the whole page fr fr 🎀 this was wallust-run from wallust-3.5, running the wallust-run(1) manual page — mwah, love u, go make something pretty 💖✨🌸🫶

📦 where this page comes from