Custom Themes
Each theme has a preview generated in the README.
The main difference between "standard" and "base16" themes is that "standard" themes follow the typical color setup, while "base16" themes follow the framework suggested by @chriskempson.
There are 2 ways to install a theme from this repo.
- 1.Download just a single file and follow the steps in the section below.
- 2.Clone the entire repo into
~/.warp/
cd ~/.warp/
git clone https://github.com/warpdotdev/themes.git
Here is a step-by-step YouTube video that goes through these 2 steps for an example theme.
Adding a Custom Theme to Warp
- 1.To start, create a config directory in your home directory:
mkdir -p ~/.warp/themes/
Note: It may take several minutes for Warp to initially discover the new config directory. You can either wait or just restart the application. After that step, all future changes to
~/.warp/themes
directory will be reflected in Warp within seconds.2. Add your new custom theme yaml theme file to this directory:
cp ~/Downloads/my_awesome_theme.yaml ~/.warp/themes/
Your new theme should now be visible on the list of available themes.
Warp supports creating custom themes using .yaml files.
The format itself might expand, but we'll do our best to avoid breaking changes and maintain forward compatibility. We also plan on supporting sharing/creating custom themes directly within Warp.
A custom theme in Warp has the following .yaml structure:
accent: '#268bd2' # Accent color for UI elements
background: '#002b36' # Terminal background color
details: darker # Whether the theme is lighter or darker.
foreground: '#839496' # The foreground color.
terminal_colors: # Ansi escape colors.
bright:
black: '#002b36'
blue: '#839496'
cyan: '#93a1a1'
green: '#586e75'
magenta: '#6c71c4'
red: '#cb4b16'
white: '#fdf6e3'
yellow: '#657b83'
normal:
black: '#073642'
blue: '#268bd2'
cyan: '#2aa198'
green: '#859900'
magenta: '#d33682'
red: '#dc322f'
white: '#eee8d5'
yellow: '#b58900'
Each color is represented in hex and must start with
#
.accent
: Color used for highlights in Warp's UIbackground
: Color of backgroundforeground
: Color of foregrounddetails
: Color used for detailing optionsdarker
: Color used for dark themelighter
: Color used for light-mode themeterminal_theme
: Collection of normal & bright colors (16 total) known for other terminal themes (ansi colors)
There are several tools out on the internet that help you create a terminal theme and generate the appropriate RGB values to enter into your YAML file. https://terminal.sexy/ is a good tool for generating RGB values.
To add a background image you can use this attribute:
background_image:
with the name of the image you want to use as the background.Note: Warp currently only supports images with the .jpg file format:
.jpeg
.jpg
.JPEG
Here is what a
.yaml
config looks like:accent: '#268bd2'
background: '#002b36'
details: darker
foreground: '#839496'
############################################################### SEE BELOW
background_image:
# the path is relative to ~/.warp/themes/
# the full path to the picture is: ~/.warp/themes/warp.jpg
path: warp.jpg
# the opacity value is required and can range from 0-100
opacity: 60
############################################################### SEE ABOVE
terminal_colors:
bright:
black: '#002b36'
blue: '#839496'
cyan: '#93a1a1'
green: '#586e75'
magenta: '#6c71c4'
red: '#cb4b16'
white: '#fdf6e3'
yellow: '#657b83'
normal:
black: '#073642'
blue: '#268bd2'
cyan: '#2aa198'
green: '#859900'
magenta: '#d33682'
red: '#dc322f'
white: '#eee8d5'
yellow: '#b58900'
To set up a gradient, create a sublevel under accent with two key-value pairs:
- "left" and "right" or
- "top" and "bottom".
accent:
top: '#abcdef'
bottom: '#fedcba'
accent:
left: '#abcdef'
right: '#fedcba'
Warp also supports setting a gradient for the background.
# accent has a gradient
accent:
left: '#474747'
right: '#ffffff'
# background has a gradient
background:
top: '#474747'
bottom: '#ffffff'
Contributions to this repo are greatly appreciated!
- 1.Fork the project
- 2.Create your branch (
git checkout -b theme/AwesomeTheme
) - 3.Regenerate thumbnails
- 4.Commit and open a pull request
Run this script to generate the thumbnails.
# assuming you're adding the theme to the `standard` directory:
python3 ./scripts/gen_theme_previews.py standard
Note: We cannot accept pull requests that include custom background images because:
- Licensing restrictions
- Trying to keep the binary size of the repo as small as possible (just the yaml files)
If your theme has an intended custom background image, include a comment in the yaml with a link to where people should download it.
We'd like to call out a few of the open-source themes and repositories that helped bootstrap the set of themes for Warp:
Last modified 13d ago