Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/oh-my-fish/theme-es

Fish shell theme
https://github.com/oh-my-fish/theme-es

Last synced: 8 days ago
JSON representation

Fish shell theme

Host: GitHub
URL: https://github.com/oh-my-fish/theme-es
Owner: oh-my-fish
License: mit
Created: 2016-01-24T23:38:48.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2023-07-16T07:22:14.000Z (over 1 year ago)
Last Synced: 2024-08-04T08:01:20.365Z (3 months ago)
Language: Shell
Homepage:
Size: 567 KB
Stars: 13
Watchers: 7
Forks: 16
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE

Awesome Lists containing this project

README

#### es theme
> A Powerline-style, Git-aware theme for [Oh My Fish][omf-link].

[![MIT License][license-badge]](/LICENSE)
[![Fish Shell Version][fish-version-badge]](https://fishshell.com)
[![Oh My Fish Framework][omf-badge]](https://www.github.com/oh-my-fish/oh-my-fish)

## Install
Make sure you have [Oh My Fish][omf-link] installed. Then just
```fish
$ omf install es
```

## Requirements
* A font patched with extra glyphs from [Powerline](https://github.com/powerline/fonts) (`E0A0-E0B3`), [Devicons][font-devicons] (`E600-E6C5`), and [Octicons ][font-octicons] (`F000-F0E8`) (see the [__Nerd Fonts__](https://github.com/ryanoasis/nerd-fonts) project for more details)

## Features

* Git-aware theme with detailed __Git status__
- at the left prompt: `added`, `removed`, `modified`, `renamed`, `unstaged`, `stashed`
- at the right prompt: `sha`
* __Node/Python/Ruby@gemset__ current version (local/global in a git folder, only local elsewhere) at the right prompt if respective virtual environment manager is installed (nodenv/NVM, pyenv, rbenv/RVM)
* __Error status__ and __duration of last command__ at the right prompt
* Mac-notifications on completion of long commands (10+ seconds by default) if terminal (iTerm and Terminal) is out of focus
* Limits path to __last two folders__ for better visibility, with `$HOME` directory abbreviated to `~`

## Configuration
* Set the following variables in your `~/.config/fish/config.fish` to define how this theme looks:
```fish
# Variable Default Option Prompt Description
set -g theme_es_show_symbols 'yes' # no ← Show pre-path symbols, e.g. read-only
set -g theme_es_extra_space '' # ' ' ← Add an extra symbol before each icon (e.g., an extra space)
set -g theme_es_verbose_git_ahead 'yes' # no ← Print the ahead/behind state for the current branch (52 instead of ⇕)
set -g theme_es_show_git_count 'no' # yes ← Show git count
set -g theme_es_spacer_count '' # ' ' ← Add extra symbol before each count (e.g., an extra space)
set -g theme_es_git_sha 'short' # long no → Show git sha (short/long)
set -g theme_es_show_user 'no' # yes → Show username
set -g theme_es_show_hostname 'yes' # no → Show hostname on SSH connections
set -g theme_es_show_node_v 'yes' # no → Show Node.js version
set -g theme_es_show_python_v 'yes' # no → Show Python version
set -g theme_es_show_ruby_v 'yes' # no → Show Ruby prompt @ gemset
set -g theme_es_notify_duration 10 # Notify if command runs longer than this time (seconds)
```

* You can also override every single icon by setting the following variables in your `~/.config/fish/config.fish`:

List of icon variable names and default values

```fish
#echo A quick test of glyph output: \Uf00a \ue709 \ue791 \ue739 \uF0DD \UF020 \UF01F \UF07B \UF015 \UF00C \UF00B \UF06B \UF06C \UF06E \UF091 \UF02C \UF026 \UF06D \UF0CF \UF03A \UF005 \UF03D \UF081 \UF02A \UE606 \UE73C
set -g theme_es_icon_NODE \UE718" " #  from Devicons or ⬢
set -g theme_es_icon_RUBY \UE791" " # \UE791 from Devicons; \UF047; \UE739; 💎
set -g theme_es_icon_PYTHON \UE606" " # \UE606; \UE73C
set -g theme_es_icon_PERL \UE606" " # \UE606; \UE73C
set -g theme_es_icon_TEST \UF091 # 
set -g theme_es_icon_VCS_STAGED \UF06B #  (added) →
set -g theme_es_icon_VCS_DELETED \UF06C # 
set -g theme_es_icon_VCS_MODIFIED \UF06D # 
set -g theme_es_icon_VCS_RENAMED \UF06E # 
set -g theme_es_icon_VCS_UNMERGED \UF026 #  #═: there are unmerged commits
set -g theme_es_icon_VCS_UNTRACKED \UF02C #  #●: there are untracked (new) files
set -g theme_es_icon_VCS_DIFF \UF06B" " # 
set -g theme_es_icon_VCS_STASH \UF0CF" " #  #✭: there are stashed commits
set -g theme_es_icon_VCS_INCOMING_CHANGES \UF00B" " #  or \UE1EB or \UE131
set -g theme_es_icon_VCS_OUTGOING_CHANGES \UF00C" " #  or \UE1EC or 
set -g theme_es_icon_VCS_TAG \UF015" " # 
set -g theme_es_icon_VCS_BOOKMARK \UF07B" " # 
set -g theme_es_icon_VCS_COMMIT \UF01F" " # 
set -g theme_es_icon_VCS_BRANCH \UE0A0 # \UE0A0 or \UF020
set -g theme_es_icon_VCS_BRANCH_REMOTE \UE804" " #  not displayed, should be branch icon on a book
set -g theme_es_icon_VCS_BRANCH_DETACHED \U27A6" " # ➦
set -g theme_es_icon_VCS_GIT \UF00A" " #  from Octicons
set -g theme_es_icon_VCS_HG \UF0DD" " # Got cut off from Octicons on patching
set -g theme_es_icon_VCS_CLEAN \UF03A # 
set -g theme_es_icon_VCS_PUSH \UF005" " # 
set -g theme_es_icon_VCS_DIRTY ± #
set -g theme_es_icon_ARROW_UP \UF03D"" #  ↑
set -g theme_es_icon_ARROW_DOWN \UF03F"" #  ↓
set -g theme_es_icon_OK \UF03A # 
set -g theme_es_icon_FAIL \UF081 # 
set -g theme_es_icon_STAR \UF02A # 
set -g theme_es_icon_JOBS \U2699" " # ⚙
set -g theme_es_icon_VIM \UE7C5" " # 
set -g theme_es_icon_LOCK  #
```

## Screenshots

### __Git folder__

### __Normal folder (no Git)__

### __Normal read-only folder (no Git)__

Icons

![Icons](../img/Icons.png?raw=true)

## License

[mit]: https://opensource.org/licenses/MIT
[author]: https://github.com/eugenesvk
[contributors]: https://github.com/oh-my-fish/theme-es/graphs/contributors
[omf-link]: https://www.github.com/oh-my-fish/oh-my-fish
[license-badge]: https://img.shields.io/badge/license-MIT-007EC7.svg?style=flat-square
[fish-version-badge]: https://img.shields.io/badge/fish-v3.0.0-007EC7.svg?style=flat-square
[omf-badge]: https://img.shields.io/badge/Oh%20My%20Fish-Framework-007EC7.svg?style=flat-square

[font-awesome]: https://github.com/FortAwesome/Font-Awesome
[font-devicons]: https://vorillaz.github.io/devicons/
[font-octicons]: https://github.com/primer/octicons
[font-material-design-icons]: https://github.com/Templarian/MaterialDesign
[font-weather]: https://github.com/erikflowers/weather-icons
[font-ryanoasis-powerline-extra-symbols]: https://github.com/ryanoasis/powerline-extra-symbols