# Theming

Atuin's themes can be customized. Atuin ships with only a couple of built-in
themes, but you can create your own themes.

To change the theme, set `theme.name` in your config file:

```toml title="~/.atuin/config.toml"
[theme]
name = "<theme>"
```

Supported themes are:

<VHSTape title="Atuin's search for cargo in the default theme, which draws it in your terminal's own colors.">
      Set FontSize 20
      Hide
      Type ` source "$ZDOTDIR/world.zsh" && clear`
      Enter
      Sleep 2s
      Show
      Sleep 300ms
      Ctrl+R
      Sleep 1s
      Type "cargo"
      Sleep 2.5s
    </VHSTape>
  <VHSTape title="Atuin's search for cargo in the autumn theme: gold, dark orange and brown.">
      Set FontSize 20
      Env ATUIN_THEME__NAME "autumn"
      Hide
      Type ` source "$ZDOTDIR/world.zsh" && clear`
      Enter
      Sleep 2s
      Show
      Sleep 300ms
      Ctrl+R
      Sleep 1s
      Type "cargo"
      Sleep 2.5s
    </VHSTape>
  <VHSTape title="Atuin's search for cargo in the marine theme: turquoise, teal and steel blue.">
      Set FontSize 20
      Env ATUIN_THEME__NAME "marine"
      Hide
      Type ` source "$ZDOTDIR/world.zsh" && clear`
      Enter
      Sleep 2s
      Show
      Sleep 300ms
      Ctrl+R
      Sleep 1s
      Type "cargo"
      Sleep 2.5s
    </VHSTape>
  <VHSTape title="Atuin's search for cargo in the pumpkin theme: orange, purple and green, from the Dracula palette.">
      Set FontSize 20
      Env ATUIN_THEME__NAME "pumpkin"
      Hide
      Type ` source "$ZDOTDIR/world.zsh" && clear`
      Enter
      Sleep 2s
      Show
      Sleep 300ms
      Ctrl+R
      Sleep 1s
      Type "cargo"
      Sleep 2.5s
    </VHSTape>
  ## Custom Themes

Atuin searches for themes in `~/.atuin/themes`, so you can create a new theme
by creating a file there:

```toml title="~/.atuin/themes/my-theme.toml"
[theme]
name = "my-theme"  # Must match the name of the file, sans .toml.

[colors]
AlertInfo = "#ff0088"              # Info messages
AlertWarn = "teal"                 # Warning messages
AlertError = "@ansi_(255)"         # Error messages
Annotation = "@rgb_(255,128,0)"    # Unimportant text
Base = "#ffffff"                   # Base foreground color
Guidance = "#00ff00"               # Help messages
Important = "#ff00ff"              # Important user messages
Title = "#ff0000"                  # Atuin's title
Muted = "#facade"                  # Muted text
SyntaxCommand = "#213213"          # `git` in `git status -h`
SyntaxFlag = "#123123"             # `-h` in `git status -h`
SyntaxString = "#ababab"           # `"hello"` in `echo "hello"`
SyntaxVariable = "#cafeed"         # `${VAR}` in `echo "${VAR}"`
SyntaxOperator = "powderblue"      # Operators like `||` `&&`.
SyntaxComment = "#c0ffee"          # Comments like `# comment`.
```

You can use the following color formats:

| Format | Description |
|--------|-------------|
| `#decade` | Hex color |
| `teal` | Any [palette](https://ogeon.github.io/docs/palette/master/palette/named/index.html)-compatible color name |
| `@ansi_(255)` | An ANSI color code |
| `@rgb_(255,128,0)` | Any RGB color |

Don't forget to change your Atuin config to use the new theme:

```toml title="~/.atuin/config.toml"
[theme]
name = "my-theme"
```

When you next run Atuin, your theme should be applied.

## Theme Builder

You can use this theme builder to help you build a theme.

<ThemeEditor />