Skip to main content

shell-themer

There are many modern *nix and *bsd command line tools which can output using a full 16.7 million color palette. For example:

Even the venerable ls can show various types of files in different colors.

Unfortunately, these tools all use slightly different color configuration mechanisms. With enough fiddling, you can get your shell init scripts to make all these tools use a similar color scheme, but if you want to change it, you've got a lot of work ahead.

shell-themer uses a single theme configuration file to standardize and unify a set of color configurations, and generates the shell code to implement those changes.

All that hand tweaking in your shell init files can now be replaced with:

export THEME_FILE=~/themes/dracula.toml
source <(shell-themer generate)

This changes all your environment variables and other settings for the many shell tools you use to reflect the colors in the theme you have specified.

Theme Files

Here's an example of a theme file:

#
# sample definition for a dracula theme

version = "1.0.0"
name = "dracula"

[styles]
# these are from https://draculatheme.com/contribute
background =  "#282a36"
foreground =  "#f8f8f2"

# styles for text and the highlighted line
# these are the only things fzf supports background colors for
text = "#f8f8f2 on default"
current_line =  "#f8f8f2 on #44475a"

# other colors from the dracula palette
comment =  "#6272a4"
cyan =  "#8be9fd"
green =  "#50fa7b"
orange =  "#ffb86c"
pink =  "#ff79c6"
purple =  "#bd93f9"
red =  "#ff5555"
yellow =  "#f1fa8c"

[scope.iterm]
agent = "iterm"
style.foreground = "foreground"
style.background = "background"

[scope.ls_colors]
agent = "environment_variables"
export.LS_COLORS = "$(vivid generate dracula)"

[scope.bat]
agent = "environment_variables"
export.BAT_THEME = "Dracula"

[scope.fzf]
agent = "fzf"
environment_variable = "FZF_DEFAULT_OPTS"
colorbase = "dark"

# command line options
opt.--pointer = "•"
opt.--prompt = "> "
opt.--bind = "ctrl-k:kill-line,ctrl-j:ignore,ctrl-u:unix-line-discard"

# these styles are special because they set both foreground and background
style.text = "text"
style.current_line = "current_line"

# no special parsing for these styles, just use the fzf color name
# highlighted substrings
style.hl = "pink"
# highlighted substrings current line
style."hl+" = "pink"
style.label = "green"
style.border = "orange"
style.prompt = "green"
style.pointer = "cyan"
style.query = "pink"

Installation

You'll need python version 3.9 or higher. Install with pipx:

$ pipx install shell_themer

You need a *nix-ish bash shell environment. Probably works in Windows Subsystem for Linux, but isn't tested there.

Metadata

Release files for shell-themer 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for shell-themer 0.7.0
File Size Uploaded Provenance
shell_themer-0.7.0.tar.gz 43.2 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for shell-themer 0.7.0
File Interpreter ABI Platform
shell_themer-0.7.0-py3-none-any.whl Python 3 none any Details

Total release size: 71.7 kB

Release files / shell_themer-0.7.0.tar.gz

Download URL shell_themer-0.7.0.tar.gz
Size 43.2 kB
Tags Source
SHA-256 checksum
How to use checksums
3b8a2d043e2c4f8cd74394a81a463c4a328fffc6fd4aa2956c82d9cac740fdcb
BLAKE2b-256 checksum
How to use checksums
d45cd1d196ffc734cce87100f9f0c4db5e0a569d39707ba07c92f1b5d4d0d5a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.13.1

Release files / shell_themer-0.7.0-py3-none-any.whl

Download URL shell_themer-0.7.0-py3-none-any.whl
Size 28.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6a0e1f51aad3cb57dfabd88652859fdb8e281673778db28cece9a1318dfa5443
BLAKE2b-256 checksum
How to use checksums
dd384ff33a2197162c90f3be151c2a226f06fa9f31fd8d16971f5b5f966df86f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.13.1

Security for shell-themer 0.7.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page