Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sobolevn/sobole-zsh-theme

Minimalistic zsh theme inspired by the old-fashioned hobbies.
https://github.com/sobolevn/sobole-zsh-theme

terminal terminal-theme theme zsh zsh-theme

Last synced: 6 days ago
JSON representation

Minimalistic zsh theme inspired by the old-fashioned hobbies.

Host: GitHub
URL: https://github.com/sobolevn/sobole-zsh-theme
Owner: sobolevn
Created: 2017-06-11T18:24:24.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-05-19T19:32:37.000Z (6 months ago)
Last Synced: 2024-10-23T05:33:55.602Z (13 days ago)
Topics: terminal, terminal-theme, theme, zsh, zsh-theme
Language: Shell
Homepage: http://sobolevn.me/sobole-zsh-theme/
Size: 7.77 MB
Stars: 145
Watchers: 3
Forks: 27
Open Issues: 3
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

# sobole

Minimalistic `zsh` theme inspired by the old-fashioned hobbies. No verbose gimmicks, no emoji, no fidget spinners, and no other visual noise.

Works best with [`oh-my-zsh`](https://github.com/robbyrussell/oh-my-zsh) and [`zsh-syntax-highlighting`](https://github.com/zsh-users/zsh-syntax-highlighting) installed.

Also provides a builtin `fzf` theme.

## Showcase

Light mode (`SOBOLE_THEME_MODE=light`):

![sobole.zsh-theme](https://raw.githubusercontent.com/sobolevn/sobole-zsh-theme/master/showcases/hyper-light.png)

And dark mode (`SOBOLE_THEME_MODE=dark`):

![sobole.zsh-theme](https://raw.githubusercontent.com/sobolevn/sobole-zsh-theme/master/showcases/ls-colors-dark.png)

There are more examples provided in the [showcases directory](/showcases).

## Installation

### zplug

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

```zsh
zplug 'sobolevn/sobole-zsh-theme', as:theme
```

### Manual

Just copy the [`sobole.zsh-theme`](/sobole.zsh-theme) to your `~/.oh-my-zsh/custom/themes/` folder.

This set of commands will probably do what you want:

```shell
git clone https://github.com/sobolevn/sobole-zsh-theme.git
ln -s $PWD/sobole-zsh-theme/sobole.zsh-theme ~/.oh-my-zsh/custom/themes/sobole.zsh-theme
```

Then set `ZSH_THEME="sobole"` inside your `.zshrc`.

Here's the [official docs](https://github.com/robbyrussell/oh-my-zsh/wiki/Customization#overriding-and-adding-themes) on how to do that.

## Features

`virtualenv`, `git`, `ls`, `grep`, `fzf`, syntax highlight, autocomplete colors, pretty error codes, different users, different color modes.

This theme also exports `$SOBOLE_SYNTAX_THEME` variable with either `'GitHub'` for light mode or `'Dracula'` to be used with tools like `bat` or `delta`.

## Configuration

This theme supports several configuration options, which are provided as `env` variables:

`$SOBOLE_THEME_MODE` - sets the theme mode. There are two options available: `light` (set by default) and `dark`. Internally changes some colors when set to `dark` to give the best look on both color schemes.

`$SOBOLE_MAX_DIR_LEN` - sets the maximum width of a displayed directory name. Defaults to `65`.

`$SOBOLE_DEFAULT_USER` - this options sets how the user is displayed. User is not displayed until it equals `$SOBOLE_DEFAULT_USER`, but imagine you executed `sudo su - admin`, that's how it will look like:

![sobole-user-showcase](https://raw.githubusercontent.com/sobolevn/sobole-zsh-theme/master/showcases/user-showcase.png)

`$SOBOLE_SYNTAX_HIGHLIGHTING` - tweaks `zsh-syntax-highlighting`. If it is installed, modifies string colors, some other minor things. Enabled by default. Set it to `'false'` if you do not want these tweaks. That's how it looks like:

![sobole-syntax-highlighting-showcase](https://raw.githubusercontent.com/sobolevn/sobole-zsh-theme/master/showcases/highlighting-tweaks.png)

If this setting is set to `'false'`, then `$SOBOLE_SYNTAX_THEME` is not exported.

`$SOBOLE_FZF_THEME` - tweaks `fzf` theme if it installed. Set it to `'false'` if you do not want these tweaks. That's how it looks like:

![sobole-fzf-tweaks](https://raw.githubusercontent.com/sobolevn/sobole-zsh-theme/master/showcases/fzf-tweaks.png)

`$SOBOLE_LESS_THEME` - tweaks `less` pager. Set it to `'false'` if you do not want these tweaks. That's how it looks like:

![sobole-less-tweaks](https://raw.githubusercontent.com/sobolevn/sobole-zsh-theme/master/showcases/less-tweaks.png)

## Indications

`sobole` supports some icons (not many of them!) to indicate what is going on.
Almost all of them are about `git` repository status. And one icon idicates that last command did not succeed.

| Symbol | Meaning |
|:------:|:-------------------------------:|
| ✗ | Repository is dirty |
| ✔ | Repository is clean |
| § | Repository has unmerged changes |
| ✚ | Repository has added files |
| ⚠️ | Last command resulted in error |

## Fonts

You can choose any font that prints unicode symbols. In the examples `Menlo Regular` is used.

You can install it with: `brew cask install font-menlo-for-powerline`. Or download it [here](https://github.com/hbin/top-programming-fonts/blob/master/Menlo-Regular.ttf).

And then [configure](http://osxdaily.com/2011/09/02/use-any-font-in-the-mac-os-x-lion-terminal/) your terminal's `font` setting.

## Using this theme

Are you using `sobole`? Add link to your dotfiles!
Currently using:

- [sobolevn's dotfiles](https://github.com/sobolevn/dotfiles)

## References

This theme borrows some setup from [`avit`](https://github.com/robbyrussell/oh-my-zsh/blob/master/themes/avit.zsh-theme) and [`obraun`](https://github.com/robbyrussell/oh-my-zsh/blob/master/themes/obraun.zsh-theme) themes.

## License

[WTFPL](https://en.wikipedia.org/wiki/WTFPL): do the fuck you want.
If you had sold it, let me know just for fun.