Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/catppuccin/tmux

💽 Soothing pastel theme for Tmux
https://github.com/catppuccin/tmux

catppuccin colors colorscheme hacktoberfest tmux tmux-conf tmux-theme

Last synced: 5 days ago
JSON representation

💽 Soothing pastel theme for Tmux

Host: GitHub
URL: https://github.com/catppuccin/tmux
Owner: catppuccin
License: mit
Created: 2021-11-11T17:28:19.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2025-01-19T07:54:32.000Z (23 days ago)
Last Synced: 2025-01-30T11:01:36.995Z (12 days ago)
Topics: catppuccin, colors, colorscheme, hacktoberfest, tmux, tmux-conf, tmux-theme
Language: Shell
Homepage:
Size: 2.24 MB
Stars: 2,090
Watchers: 9
Forks: 659
Open Issues: 20
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-tmux - catppuccin

README

        


 


 

 Catppuccin for Tmux

 





    

    

    





  



## Themes

🌻 Latte

![Latte Flavor Preview](./assets/latte.webp)

🪴 Frappé

![Frappe Flavor Preview](./assets/frappe.webp)

🌺 Macchiato

![Macchiato Flavor Preview](./assets/macchiato.webp)

🌿 Mocha

![Mocha Flavor Preview](./assets/mocha.webp)

## Installation

In order to have the icons displayed correctly please use/update your favorite

[nerd font](https://www.nerdfonts.com/font-downloads).

If you do not have a patched font installed, you can override or remove any

icon. Check the [documentation](./docs/reference/configuration.md) on the

options available.

### Manual (Recommended)

This method is recommended as TPM has some issues with name conflicts.

1. Clone this repository to your desired location (e.g.

   `~/.config/tmux/plugins/catppuccin`).

   ```bash

   mkdir -p ~/.config/tmux/plugins/catppuccin

   git clone -b v2.1.2 https://github.com/catppuccin/tmux.git ~/.config/tmux/plugins/catppuccin/tmux

   ```

1. Add the following line to your `tmux.conf` file:

   `run ~/.config/tmux/plugins/catppuccin/tmux/catppuccin.tmux`.

1. Reload Tmux by either restarting or reloading with `tmux source ~/.tmux.conf`.

Check out what to do next in the "[Getting Started Guide](./docs/tutorials/01-getting-started.md)".

### TPM

1.  Install [TPM](https://github.com/tmux-plugins/tpm)

1.  Add the Catppuccin plugin:

    ```bash

    set -g @plugin 'catppuccin/tmux#v2.1.2' # See https://github.com/catppuccin/tmux/tags for additional tags

    # ...alongside

    set -g @plugin 'tmux-plugins/tpm'

    ```

1.  (Optional) Set your preferred flavor, it defaults to `"mocha"`:

        ```bash

        set -g @catppuccin_flavor 'mocha' # latte, frappe, macchiato or mocha

        ```

    

> [!IMPORTANT]

> You may have to run `~/.config/tmux/plugins/tpm/bin/clean_plugins`

> if upgrading from an earlier version

> (especially from `v0.3.0`).

### For TMUX versions prior to 3.2

This plugin uses features that were only introduced into tmux in version 3.2.

If you are using a version earlier than this, you can still have lovely

catppuccin colors, the installation method just looks a little different.

```sh

# In your ~/.tmux.conf

# Add the colors from the pallete. Check the themes/ directory for all options.

# Some basic mocha colors.

set -g @ctp_bg "#24273a"

set -g @ctp_surface_1 "#494d64"

set -g @ctp_fg "#cad3f5"

set -g @ctp_mauve "#c6a0f6"

set -g @ctp_crust "#181926"

# status line

set -gF status-style "bg=#{@ctp_bg},fg=#{@ctp_fg}"

# windows

set -gF window-status-format "#[bg=#{@ctp_surface_1},fg=#{@ctp_fg}] ##I ##T "

set -gF window-status-current-format "#[bg=#{@ctp_mauve},fg=#{@ctp_crust}] ##I ##T "

```

### Upgrading from v0.3

Breaking changes have been introduced since 0.3, to understand how to migrate

your configuration, see pinned issue [#291](https://github.com/catppuccin/tmux/issues/291).

## Recommended Default Configuration

This configuration shows some customisation options, that can be further

extended as desired.

This is what is used for the previews above.

![Example configuration](./assets/mocha.webp)

```bash

# ~/.tmux.conf

# Options to make tmux more pleasant

set -g mouse on

set -g default-terminal "tmux-256color"

# Configure the catppuccin plugin

set -g @catppuccin_flavor "mocha"

set -g @catppuccin_window_status_style "rounded"

# Load catppuccin

run ~/.config/tmux/plugins/catppuccin/tmux/catppuccin.tmux

# For TPM, instead use `run ~/.config/tmux/plugins/tmux/catppuccin.tmux`

# Make the status line pretty and add some modules

set -g status-right-length 100

set -g status-left-length 100

set -g status-left ""

set -g status-right "#{E:@catppuccin_status_application}"

set -agF status-right "#{E:@catppuccin_status_cpu}"

set -ag status-right "#{E:@catppuccin_status_session}"

set -ag status-right "#{E:@catppuccin_status_uptime}"

set -agF status-right "#{E:@catppuccin_status_battery}"

run ~/.config/tmux/plugins/tmux-plugins/tmux-cpu/cpu.tmux

run ~/.config/tmux/plugins/tmux-plugins/tmux-battery/battery.tmux

# Or, if using TPM, just run TPM

```

## Documentation

### Guides

- [Getting Started](./docs/tutorials/01-getting-started.md)

- [Custom Status Line Segments](./docs/tutorials/02-custom-status.md)

- [Troubleshooting](./docs/guides/troubleshooting.md)

### Reference

- [Status Line](./docs/reference/status-line.md)

- [Configuration Options Reference](./docs/reference/configuration.md)

- [Tmux Configuration Showcase](https://github.com/catppuccin/tmux/discussions/317)

## 💝 Thanks to

- [Pocco81](https://github.com/Pocco81)

- [vinnyA3](https://github.com/vinnyA3)

- [rogeruiz](https://github.com/rogeruiz)

- [kales](https://github.com/kjnsn)

 





Copyright © 2021-present Catppuccin Org