Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/carloscuesta/materialshell

A material design theme for your terminal. ✨
https://github.com/carloscuesta/materialshell

material-design materialshell shell zsh

Last synced: 4 days ago
JSON representation

A material design theme for your terminal. ✨

Awesome Lists containing this project

README

        

# 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://cloud.githubusercontent.com/assets/7629661/11194912/348e69f6-8caf-11e5-97ec-876bd6565125.gif)

> 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.

### [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:

- [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 | Oceanic |
| :--: | :-----: |
| ![materialshell dark](https://cloud.githubusercontent.com/assets/7629661/24923003/7b2ffa8a-1ef0-11e7-9092-dea1c694f667.png) | ![materialshell oceanic](https://cloud.githubusercontent.com/assets/7629661/24923004/7b4efe9e-1ef0-11e7-8804-ab3090ec1394.png) |