Files
color-tool/color-tool
T
rootiest 5c87e382de feat: modernize color-tool with multiple formats, HSL support, and embedded picker
- Added --output flag supporting hex, rgb, hsl, rgba, hsla, hexa, and 'all' formats
- Implemented HSL/HSLA conversion using internal Python logic
- Added --[no-] prefix support for all toggleable flags (json, name, swatch, copy, notify, pick)
- Embedded KDE Plasma color picker Python script within the main bash script for portability
- Refactored argument parsing to implement a robust priority system (CLI > Desktop Config > Default Config)
- Improved validation to catch invalid output formats before triggering the color picker
- Updated installation logic to generate all necessary components and sample configuration
- Fixed swatch formatting when outputting JSON
- Refined desktop mode behavior and configurability
2026-04-27 22:40:55 -04:00

505 lines
18 KiB
Bash
Executable File

#!/usr/bin/env bash
# color-tool — pick, convert, and format colors
# Supports: hex → RGB/RGBA, KDE Plasma color picker, clipboard copy, JSON output, color names
set -euo pipefail
# ── Configuration ─────────────────────────────────────────────────────────────
# Resolve the real directory of this script so we can find bundled helpers
SCRIPT_DIR="$(dirname "$(readlink -f "$0")")"
CONFIG_FILE="$HOME/.config/color-tool/config.toml"
# ── Initial Defaults ──────────────────────────────────────────────────────────
# Hardcoded base defaults
json_mode=0
alpha_mode=0
name_mode=0
copy_mode=0
desktop_mode=0
notify_mode=0
swatch_mode=0
config_pick=0
output_formats="hex"
# Desktop-specific defaults (initially same as base, can be overridden by config)
desktop_json=0
desktop_alpha=0
desktop_name=0
desktop_notify=1
desktop_copy=1
desktop_output="hex"
# Track which settings were explicitly set via CLI flags to ensure they override config
cli_json=""
cli_alpha=""
cli_name=""
cli_copy=""
cli_notify=""
cli_swatch=""
cli_pick=""
cli_output=""
# ── Config Loader ─────────────────────────────────────────────────────────────
# Parse ~/.config/color-tool/config.toml and apply [defaults] and [desktop] values.
load_config() {
[[ ! -f "$CONFIG_FILE" ]] && return 0
local section="" key val
while IFS= read -r line; do
line="${line%%#*}" # strip inline comments
if [[ "$line" =~ ^[[:space:]]*$ ]]; then continue; fi
# Section header
if [[ "$line" =~ ^\[([A-Za-z_-]+)\]$ ]]; then
section="${BASH_REMATCH[1]}"
continue
fi
# key = value
if [[ "$line" =~ ^[[:space:]]*([A-Za-z_]+)[[:space:]]*=[[:space:]]*([^[:space:]]+) ]]; then
key="${BASH_REMATCH[1]}"
val="${BASH_REMATCH[2],,}"
val="${val#\"}" ; val="${val%\"}"
case "$section:$key" in
defaults:json) [[ "$val" == "true" ]] && json_mode=1 || json_mode=0 ;;
defaults:alpha) [[ "$val" == "true" ]] && alpha_mode=1 || alpha_mode=0 ;;
defaults:name) [[ "$val" == "true" ]] && name_mode=1 || name_mode=0 ;;
defaults:copy) [[ "$val" == "true" ]] && copy_mode=1 || copy_mode=0 ;;
defaults:pick) [[ "$val" == "true" ]] && config_pick=1 || config_pick=0 ;;
defaults:notify) [[ "$val" == "true" ]] && notify_mode=1 || notify_mode=0 ;;
defaults:swatch) [[ "$val" == "true" ]] && swatch_mode=1 || swatch_mode=0 ;;
defaults:output) output_formats="$val" ;;
desktop:json) [[ "$val" == "true" ]] && desktop_json=1 || desktop_json=0 ;;
desktop:alpha) [[ "$val" == "true" ]] && desktop_alpha=1 || desktop_alpha=0 ;;
desktop:name) [[ "$val" == "true" ]] && desktop_name=1 || desktop_name=0 ;;
desktop:notify) [[ "$val" == "true" ]] && desktop_notify=1 || desktop_notify=0 ;;
desktop:copy) [[ "$val" == "true" ]] && desktop_copy=1 || desktop_copy=0 ;;
desktop:output) desktop_output="$val" ;;
esac
fi
done < "$CONFIG_FILE"
}
# ── Help ──────────────────────────────────────────────────────────────────────
show_help() {
local bold='\033[1m'
local dim='\033[2m'
local reset='\033[0m'
local cyan='\033[36m'
local yellow='\033[33m'
local mag='\033[35m'
printf "\n"
# Title: "color" in a rainbow gradient, "-tool" in bold
printf " ${bold}\033[38;2;255;80;80mc\033[38;2;255;160;0mo\033[38;2;220;210;0ml\033[38;2;80;200;80mo\033[38;2;80;160;255mr${reset}${bold}-tool${reset}"
printf " ${dim}— pick, convert, and format colors${reset}\n\n"
printf " ${bold}${yellow}Usage${reset} ${cyan}${0##*/}${reset} ${dim}[OPTIONS]${reset} [COLOR ...]\n\n"
printf " ${bold}${yellow}Options${reset}\n"
printf " ${bold}${cyan}--[no-]pick${reset} Open the KDE Plasma color picker ${dim}(requires KDE + Wayland)${reset}\n"
printf " ${bold}${cyan}--output${reset} ${dim}FMT${reset} Format(s) to output: ${cyan}hex, rgb, hsl, rgba, hsla, hexa, all${reset} ${dim}(comma-separated)${reset}\n"
printf " ${bold}${cyan}--[no-]json${reset} Output as a JSON table of selected formats\n"
printf " ${bold}${cyan}--[no-]name${reset} Fetch nearest color name from thecolorapi.com ${dim}(requires curl, jq)${reset}\n"
printf " ${bold}${cyan}--[no-]swatch${reset} Include a color swatch in the terminal output\n"
printf " ${bold}${cyan}--[no-]copy${reset} Copy result to clipboard ${dim}(wl-copy preferred, xclip as fallback)${reset}\n"
printf " ${bold}${cyan}--[no-]notify${reset} Show desktop notification ${dim}(on by default in --desktop)${reset}\n"
printf " ${bold}${cyan}--desktop${reset} GUI mode: pick → copy → notify ${dim}(for app menu / .desktop launcher)${reset}\n"
printf " ${bold}${cyan}--install${reset} Install to ~/.local/share/color-tool/ and symlink into ~/.local/bin/\n"
printf " ${bold}${cyan}--help${reset}, ${bold}${cyan}-h${reset} Show this help message\n\n"
printf " ${bold}${yellow}Examples${reset}\n"
printf " ${cyan}${0##*/}${reset} ${mag}\"#534145\"${reset} --swatch\n"
printf " ${cyan}${0##*/}${reset} --pick --output rgb,hsl --json\n"
printf " ${cyan}${0##*/}${reset} \"rgb(255, 100, 0)\" --output hex,hsla\n\n"
printf " ${bold}${yellow}Config${reset} ${dim}~/.config/color-tool/config.toml${reset}\n"
printf " ${dim}[defaults]${reset} keys: ${cyan}output json swatch name copy pick notify${reset}\n"
printf " ${dim}[desktop]${reset} keys: ${cyan}output json name notify copy${reset} ${dim}(pick always on)${reset}\n\n"
}
# ── Environment detection ─────────────────────────────────────────────────────
check_kde_wayland() {
if [[ -z "${WAYLAND_DISPLAY:-}" ]]; then
echo "Error: color picker requires a Wayland session (WAYLAND_DISPLAY is not set)" >&2
return 1
fi
local desktop="${XDG_CURRENT_DESKTOP:-}"
if [[ "$desktop" != *KDE* ]] && [[ -z "${KDE_FULL_SESSION:-}" ]]; then
echo "Error: color picker requires KDE Plasma (current desktop: ${desktop:-unknown})" >&2
return 1
fi
}
# ── Clipboard & Notifications ─────────────────────────────────────────────────
copy_to_clipboard() {
local text="$1"
if command -v wl-copy &>/dev/null; then
printf '%s' "$text" | wl-copy
elif command -v xclip &>/dev/null; then
printf '%s' "$text" | xclip -selection clipboard
else
echo "Warning: no clipboard utility found (install wl-copy or xclip)" >&2
echo " Value: $text" >&2
return 1
fi
}
notify_result() {
local value="$1"
command -v notify-send &>/dev/null || return 0
notify-send -i "color-picker" "color-tool" "$value" || true
}
# ── Color picker ──────────────────────────────────────────────────────────────
# Generate the internal Python helper for KDE Plasma color picking
generate_picker_script() {
local target="$1"
cat > "$target" <<'EOF'
#!/usr/bin/python3
from PyQt6.QtDBus import QDBusConnection, QDBusMessage, QDBusPendingReply, QDBusPendingCallWatcher
from PyQt6.QtCore import QCoreApplication
from PyQt6.QtGui import QColor
import sys
def colorPicked():
reply = QDBusPendingReply(call)
if reply.isError():
print(reply.error().message(), file=sys.stderr)
else:
print(QColor(reply.argumentAt(0)[0]).name())
app = QCoreApplication(sys.argv)
msg = QDBusMessage.createMethodCall("org.kde.KWin", "/ColorPicker", "org.kde.kwin.ColorPicker", "pick")
call = QDBusConnection.sessionBus().asyncCall(msg)
watcher = QDBusPendingCallWatcher(call, app)
watcher.finished.connect(colorPicked)
watcher.waitForFinished()
EOF
chmod +x "$target"
}
run_color_picker() {
check_kde_wayland || return 1
local picker_path="$SCRIPT_DIR/wl-colorpicker-plasma.py"
local cleanup=0
if [[ ! -f "$picker_path" ]]; then
picker_path=$(mktemp /tmp/wl-colorpicker-XXXXXX.py)
generate_picker_script "$picker_path"
cleanup=1
fi
local picked
picked=$(python3 "$picker_path")
local exit_code=$?
[[ $cleanup -eq 1 ]] && rm -f "$picker_path"
if [[ $exit_code -eq 0 ]]; then
echo "$picked"
else
return 1
fi
}
# ── Installation Helpers ──────────────────────────────────────────────────────
suggest_path_add() {
local bin_dir="$1" is_fish=0
[[ "${SHELL:-}" == */fish ]] && is_fish=1
if [[ $is_fish -eq 0 ]]; then
local parent
parent=$(ps -p "$PPID" -o comm= 2>/dev/null || true)
[[ "$parent" == *fish* ]] && is_fish=1
fi
if [[ $is_fish -eq 1 ]]; then
printf " Run: fish_add_path %s\n" "$bin_dir"
else
printf " For bash/zsh: export PATH=\"%s:\$PATH\"\n" "$bin_dir"
printf " For fish: fish_add_path %s\n" "$bin_dir"
fi
}
do_install() {
local data_dir="$HOME/.local/share/color-tool"
local bin_dir="$HOME/.local/bin"
local bin_link="$bin_dir/color-tool"
local src_script
src_script="$(readlink -f "$0")"
mkdir -p "$data_dir" "$bin_dir"
cp "$src_script" "$data_dir/color-tool"
chmod +x "$data_dir/color-tool"
generate_picker_script "$data_dir/wl-colorpicker-plasma.py"
ln -sf "$data_dir/color-tool" "$bin_link"
local config_dir="$HOME/.config/color-tool"
local config_file="$config_dir/config.toml"
mkdir -p "$config_dir"
if [[ ! -f "$config_file" ]]; then
cat > "$config_file" <<'EOF'
# color-tool configuration
# https://github.com/rootiest/color-tool
[defaults]
# Set any option to true to enable it by default when using the terminal
output = "hex" # default output format(s): hex, rgb, hsl, rgba, hsla, hexa, all
json = false # output in JSON format
alpha = false # include alpha channel (8-digit hex)
swatch = false # show color swatch in terminal
name = false # fetch color name from thecolorapi.com
copy = false # copy result to clipboard
pick = false # auto-launch color picker when invoked with no arguments
notify = false # show desktop notification
[desktop]
# Defaults for --desktop mode (launched from the app menu; copy is always enabled by default)
output = "hex" # format to copy
json = false # copy JSON format instead of plain text
alpha = false # include alpha channel
name = false # fetch color name (requires network)
copy = true # copy result to clipboard
notify = true # show desktop notification with the copied value
EOF
printf " config %s (sample created)\n" "$config_file"
else
printf " config %s\n" "$config_file"
fi
local app_dir="$HOME/.local/share/applications"
local desktop_file="$app_dir/color-tool.desktop"
local bin_path="$HOME/.local/bin/color-tool"
mkdir -p "$app_dir"
cat > "$desktop_file" <<EOF
[Desktop Entry]
Version=1.1
Type=Application
Name=Color Tool
Comment=Pick a color and copy it to the clipboard
Exec=$bin_path --desktop
Icon=color-picker
Categories=Utility;Graphics;
Keywords=color;picker;hex;rgb;clipboard;
Terminal=false
NoDisplay=false
EOF
printf " app %s\n" "$desktop_file"
printf "Installed:\n"
printf " data %s/\n" "$data_dir"
printf " bin %s -> %s\n" "$bin_link" "$data_dir/color-tool"
if [[ ":$PATH:" != *":$bin_dir:"* ]]; then
printf "\nNote: %s is not in your PATH.\n" "$bin_dir"
suggest_path_add "$bin_dir"
fi
}
# ── Color conversion ──────────────────────────────────────────────────────────
get_all_formats() {
local input="$1"
python3 -c "
import colorsys, json, sys, re
def parse_input(val):
val = val.strip().lower()
hex_match = re.match(r'^#?([0-9a-f]{3}|[0-9a-f]{6}|[0-9a-f]{8})$', val)
if hex_match:
h = hex_match.group(1)
if len(h) == 3: h = ''.join([c*2 for c in h])
if len(h) == 6: h += 'ff'
return int(h[0:2], 16), int(h[2:4], 16), int(h[4:6], 16), int(h[6:8], 16)
rgba_match = re.match(r'^rgba?\(?(\d+),\s*(\d+),\s*(\d+)(?:,\s*([\d.]+))?\)?$', val)
if rgba_match:
r, g, b = map(int, rgba_match.groups()[:3])
r, g, b = max(0, min(255, r)), max(0, min(255, g)), max(0, min(255, b))
a = float(rgba_match.group(4)) if rgba_match.group(4) else 1.0
return r, g, b, int(max(0, min(1, a)) * 255)
hsla_match = re.match(r'^hsla?\(?(\d+),\s*(\d+)%?,\s*(\d+)%?(?:,\s*([\d.]+))?\)?$', val)
if hsla_match:
h, s, l = map(int, hsla_match.groups()[:3])
h, s, l = h % 360, max(0, min(100, s)), max(0, min(100, l))
a = float(hsla_match.group(4)) if hsla_match.group(4) else 1.0
r, g, b = colorsys.hls_to_rgb(h/360.0, l/100.0, s/100.0)
return int(r*255), int(g*255), int(b*255), int(max(0, min(1, a)) * 255)
return None
res = parse_input('''$input''')
if not res: sys.exit(1)
r, g, b, a = res
h, l, s = colorsys.rgb_to_hls(r/255.0, g/255.0, b/255.0)
formats = {
'hex': f'#{r:02x}{g:02x}{b:02x}',
'hexa': f'#{r:02x}{g:02x}{b:02x}{a:02x}',
'rgb': f'rgb({r}, {g}, {b})',
'rgba': f'rgba({r}, {g}, {b}, {round(a/255.0, 2)})',
'hsl': f'hsl({round(h*360)}, {round(s*100)}%, {round(l*100)}%)',
'hsla': f'hsla({round(h*360)}, {round(s*100)}%, {round(l*100)}%, {round(a/255.0, 2)})',
'_raw': {'r': r, 'g': g, 'b': b, 'a': a}
}
print(json.dumps(formats))
"
}
validate_output_formats() {
local formats="$1"
local valid_fmts=("hex" "hexa" "rgb" "rgba" "hsl" "hsla")
IFS=',' read -ra ADDR <<< "$formats"
for fmt in "${ADDR[@]}"; do
[[ "$fmt" == "all" ]] && continue
local is_valid=0
for v in "${valid_fmts[@]}"; do [[ "$fmt" == "$v" ]] && is_valid=1 && break; done
if [[ $is_valid -eq 0 ]]; then
echo "Error: Invalid output format: $fmt" >&2
echo "Valid formats: ${valid_fmts[*]}, all" >&2
return 1
fi
done
return 0
}
process_color() {
local input="$1"
local formats_json
formats_json=$(get_all_formats "$input") || { echo "Error: Invalid color: $input" >&2; return 1; }
local name=""
if [[ $name_mode -eq 1 ]]; then
local hex_for_api
hex_for_api=$(echo "$formats_json" | jq -r '.hex' | tr -d '#')
name=$(curl -s "https://www.thecolorapi.com/id?hex=$hex_for_api" | jq -r '.name.value // empty')
fi
local selected_fmts=()
local valid_fmts=("hex" "hexa" "rgb" "rgba" "hsl" "hsla")
IFS=',' read -ra ADDR <<< "$output_formats"
for fmt in "${ADDR[@]}"; do
if [[ "$fmt" == "all" ]]; then
selected_fmts=("${valid_fmts[@]}")
break
else
selected_fmts+=("$fmt")
fi
done
local display_parts=()
local json_obj="{}"
for fmt in "${selected_fmts[@]}"; do
local val
val=$(echo "$formats_json" | jq -r ".$fmt // empty")
if [[ -n "$val" ]]; then
display_parts+=("$val")
json_obj=$(echo "$json_obj" | jq --arg k "$fmt" --arg v "$val" '. + {($k): $v}')
fi
done
[[ -n "$name" ]] && json_obj=$(echo "$json_obj" | jq --arg v "$name" '. + {"name": $v}')
local output_text
if [[ $json_mode -eq 1 ]]; then
output_text="$json_obj"
else
output_text=$(IFS=' ' ; echo "${display_parts[*]}")
[[ -n "$name" ]] && output_text="$output_text ($name)"
fi
if [[ $desktop_mode -eq 0 ]]; then
if [[ $swatch_mode -eq 1 ]]; then
local r g b
r=$(echo "$formats_json" | jq -r '._raw.r')
g=$(echo "$formats_json" | jq -r '._raw.g')
b=$(echo "$formats_json" | jq -r '._raw.b')
if [[ $json_mode -eq 1 ]]; then printf "\033[48;2;${r};${g};${b}m \033[0m\n"
else printf "\033[48;2;${r};${g};${b}m \033[0m "; fi
fi
echo -e "$output_text"
fi
[[ $copy_mode -eq 1 ]] && copy_to_clipboard "$output_text" || true
[[ $notify_mode -eq 1 ]] && notify_result "$output_text" || true
}
# ── Argument parsing ──────────────────────────────────────────────────────────
load_config
args=()
do_pick=0
# First pass: collect CLI overrides
while [[ $# -gt 0 ]]; do
case "$1" in
--help|-h) show_help; exit 0 ;;
--output) cli_output="$2"; shift ;;
--json) cli_json=1 ;;
--no-json) cli_json=0 ;;
--alpha) cli_alpha=1; cli_output="hexa" ;;
--no-alpha)cli_alpha=0 ;;
--name) cli_name=1 ;;
--no-name) cli_name=0 ;;
--swatch) cli_swatch=1 ;;
--no-swatch)cli_swatch=0 ;;
--copy) cli_copy=1 ;;
--no-copy) cli_copy=0 ;;
--notify) cli_notify=1 ;;
--no-notify)cli_notify=0 ;;
--pick) cli_pick=1 ;;
--no-pick) cli_pick=0 ;;
--desktop) desktop_mode=1 ;;
--install) do_install; exit 0 ;;
-*) echo "Unknown option: $1" >&2; exit 1 ;;
*) args+=("$1") ;;
esac
shift
done
# Apply final hierarchy: CLI Flags > Desktop Config (if --desktop) > Default Config
if [[ $desktop_mode -eq 1 ]]; then
json_mode=${cli_json:-$desktop_json}
alpha_mode=${cli_alpha:-$desktop_alpha}
name_mode=${cli_name:-$desktop_name}
notify_mode=${cli_notify:-$desktop_notify}
output_formats=${cli_output:-$desktop_output}
copy_mode=${cli_copy:-$desktop_copy}
do_pick=${cli_pick:-1}
swatch_mode=${cli_swatch:-0} # swatch usually off in desktop mode
else
json_mode=${cli_json:-$json_mode}
alpha_mode=${cli_alpha:-$alpha_mode}
name_mode=${cli_name:-$name_mode}
notify_mode=${cli_notify:-$notify_mode}
output_formats=${cli_output:-$output_formats}
copy_mode=${cli_copy:-$copy_mode}
do_pick=${cli_pick:-0}
swatch_mode=${cli_swatch:-$swatch_mode}
fi
# Validation
validate_output_formats "$output_formats" || exit 1
# Stdin support
[[ ! -t 0 ]] && while read -r line; do [[ -n "$line" ]] && args+=("$line"); done
# Execution
if [[ $do_pick -eq 1 ]]; then
picked="$(run_color_picker)" || exit 1
[[ -n "$picked" ]] && args+=("$picked")
elif [[ ${#args[@]} -eq 0 ]]; then
if [[ $config_pick -eq 1 ]]; then
picked="$(run_color_picker)" || exit 1
[[ -n "$picked" ]] && args+=("$picked")
elif [[ -t 0 ]]; then
show_help; exit 0
fi
fi
for color in "${args[@]}"; do process_color "$color"; done