Custom Themes
Warp supports Custom Themes which can be created manually or downloaded from our repo.
Examples and a collection of themes can be found in the Warp themes repository.
Warp's Custom Theme Repository
We have a repository of themes hosted on GitHub.
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.
Download a single file and follow the steps in the section below.
Clone the entire repo into the appropriate location based on your OS below:
Here is a step-by-step YouTube video that goes through these 2 steps for an example theme. Note the location for the files is based on macOS.
How do I use a custom theme in Warp?
To start, create the following directory:
mkdir -p ~/.warp/themes/
It may take several minutes for Warp to initially discover the new themes directory. You can either wait or restart Warp. After that step, all future changes to the directory will be reflected within seconds.
Add your new custom theme yaml file to this directory:
Your new theme should now be visible on the list of available themes.
Create your custom theme, manually
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:
Each color is represented in hex and must start with #
.
name
: Name for the theme, will show up in the Theme picker.accent
: Color used for highlights in Warp's UIcursor
: Color for the input cursorbackground
: Color of backgroundforeground
: Color of foregroundcursor
: (Optional) color used for the cursor. Defaults to theaccent
color.details
: Color used for detailing optionsdarker
: Color used for dark themelighter
: Color used for light-mode theme
terminal_colors
: Collection of normal & bright colors (16 total) known for other terminal themes (ANSI colors)
Create your custom theme, automatically
Automatically create new themes based on a background image. Click the +
button in the theme picker Settings > Appearance > Current Theme
or search Open Theme Picker
within the Command Palette.
Create your custom theme, with a tool
Use Terminal-Themes to create a custom theme and generate the appropriate RGB values for your custom theme. Once the YAML file is created, you can edit the file to add the background images or gradients.
Background Images and Gradients
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
A .yaml
config looks like this:
To set up a gradient, create a sublevel under accent with two key-value pairs:
"left" and "right" or
"top" and "bottom".
Warp also supports setting a gradient for the background.
Contributing
Contributions to this repo are greatly appreciated!
Fork the project
Create your branch with
git checkout -b theme/AwesomeTheme
Regenerate thumbnails
Commit and open a pull request
Run this script to generate the thumbnails.
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 (only 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.
Community
All other Warp-related things can be discussed in our Warp official repo or our Discord server.
Open source dependencies
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 updated