# materialshell

[![GitHub license](https://img.shields.io/github/license/carloscuesta/materialshell.svg?style=flat-square)](https://github.com/carloscuesta/materialshell)
[![GitHub release](https://img.shields.io/github/release/carloscuesta/materialshell.svg?style=flat-square)](https://github.com/carloscuesta/materialshell)

![materialshell](https://github.com/user-attachments/assets/af6622d9-6a8e-465c-822c-e748e1cd6090#gh-dark-mode-only)
![materialshell](https://github.com/user-attachments/assets/bd8238cd-d81c-46a8-bbce-94e827dfd0f0#gh-light-mode-only)

> A [material design](https://material.google.com/style/color.html) theme for your shell with a good contrast and color pops at the important parts. Designed to be easy on the eyes.

## Install

### [antigen](http://antigen.sharats.me)

Add the following snippet to your `.zshrc` file after `antigen use oh-my-zsh`:

```sh
antigen theme carloscuesta/materialshell materialshell
```

### [antibody](https://github.com/getantibody/antibody)

Add the following snippet to your `.zshrc` file:

```sh
antibody bundle carloscuesta/materialshell
```

### [Fig](https://fig.io)

Fig adds apps, shortcuts, and autocomplete to your existing terminal.


Install `materialshell` in just one click.

<a href="https://fig.io/plugins/other/materialshell_carloscuesta" target="_blank"><img src="https://fig.io/badges/install-with-fig.svg" /></a>

### [zgen](https://github.com/tarjoilija/zgen)

Add the following snippet to your `.zshrc` file:

```sh
zgen load carloscuesta/materialshell materialshell
```

### [zplug](https://github.com/zplug/zplug)

Add the following snippet to your `.zshrc` file:

```sh
zplug carloscuesta/materialshell, use:materialshell.zsh, from:github, as:theme
```

### Manual

1. Install [`oh-my-zsh`](https://ohmyz.sh/#install)

2. Run the following command in your terminal:

```sh
curl -L -o ~/.oh-my-zsh/custom/themes/materialshell.zsh-theme https://raw.githubusercontent.com/carloscuesta/materialshell/master/materialshell.zsh
```

If you don't have curl, just copy `materialshell.zsh` to `~/.oh-my-zsh/custom/themes/materialshell.zsh-theme`.

3. Modify `.zshrc` to enable the theme with `ZSH_THEME="materialshell"`.

4. Save and restart your terminal.

## Colors

These are the colors used in both versions of the materialshell (Dark & Oceanic).

![materialshell color palette](https://cloud.githubusercontent.com/assets/7629661/11169947/1337b238-8bc6-11e5-8eaa-37d435b9ecee.png)

By **default** colors come built-in with the zsh theme. These are the **color themes** for your **Terminal emulators**. Select the one you use to see the instructions:

- [Ghostty](https://github.com/carloscuesta/materialshell/tree/master/shell-color-themes#ghostty)
- [iTerm](https://github.com/carloscuesta/materialshell/tree/master/shell-color-themes#iterm)
– [macOS Terminal](https://github.com/carloscuesta/materialshell/tree/master/shell-color-themes#terminal)
- [Cmder](https://github.com/carloscuesta/materialshell/tree/master/shell-color-themes#cmder)
- [Hyper](https://github.com/carloscuesta/materialshell/tree/master/shell-color-themes#hyper)
- [Windows Terminal](/shell-color-themes/README.md#windows-terminal)
- [Other (manual)](https://github.com/carloscuesta/materialshell/tree/master/shell-color-themes#manual)

## Screenshots

| Dark | Light | Oceanic |
|---|---|---|
| ![materialshell dark](https://github.com/user-attachments/assets/da60e9dd-4ff7-4dc5-9b46-e6d6f2ed1ca3) | ![materialshell light](https://github.com/user-attachments/assets/abd9b7c8-2001-4eaa-94af-39df68c9f81e) | ![materialshell oceanic](https://github.com/user-attachments/assets/325e6b02-92de-4ab2-9c20-5e2752acf058) |