https://github.com/m-lima/simpalt
An information-rich-small-footprint theme for zsh based on agnoster
https://github.com/m-lima/simpalt
Last synced: about 1 month ago
JSON representation
An information-rich-small-footprint theme for zsh based on agnoster
- Host: GitHub
- URL: https://github.com/m-lima/simpalt
- Owner: m-lima
- License: mit
- Created: 2018-11-09T21:50:22.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-11-28T12:42:44.000Z (almost 3 years ago)
- Last Synced: 2024-04-20T18:50:39.064Z (over 1 year ago)
- Language: Shell
- Homepage:
- Size: 364 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-zsh-plugins - simpalt - An information-rich small-footprint theme for ZSH based on [Agnoster](https://github.com/agnoster/agnoster-zsh-theme). (Themes / ZSH on Windows)
- fucking-awesome-zsh-plugins - simpalt - An information-rich small-footprint theme for ZSH based on <b><code> 4169⭐</code></b> <b><code> 590🍴</code></b> [Agnoster](https://github.com/agnoster/agnoster-zsh-theme)). (Themes / ZSH on Windows)
- awesome-zsh-plugins - simpalt - An information-rich small-footprint theme for ZSH based on [Agnoster](https://github.com/agnoster/agnoster-zsh-theme). (Themes / Zinit (née zplugin))
README
Simpalt
=====================
A ZSH theme based on [agnoster](https://github.com/agnoster/agnoster-zsh-theme) with focus on screen real estate.
###### Demo
[](https://asciinema.org/a/gYRKD3Hdv9dvcZ6JiCyWlvhkM)
How to use it
---------------------
### Software Requirement
* [ZSH](https://www.zsh.org/)
### Supported frameworks
* [Vanilla ZSH](https://www.zsh.org/)
* [Oh My ZSH](https://github.com/robbyrussell/oh-my-zsh)
* [Prezto](https://github.com/sorin-ionescu/prezto)
* [ZGen](https://github.com/sorin-ionescu/prezto)
* [ZPlug](https://github.com/sorin-ionescu/prezto)
### Initial setup
```bash
$ brew install zsh
$ chsh -s $(which zsh)
```
Installing the theme
---------------------
#### Using ZGen
Add the following to your `.zshrc`
```bash
if ! zgen saved; then
...
zgen load m-lima/simpalt simpalt.zsh-theme
...
zgen save
fi
```
#### Using ZGen with Prezto
Add the following to your `.zshrc`
```bash
if ! zgen saved; then
zgen prezto
zgen prezto prompt theme 'simpalt'
...
zgen load m-lima/simpalt
...
zgen save
fi
```
#### Using ZPlug
Add the following to your `.zshrc`
```bash
zplug "m-lima/simpalt", as:theme
```
#### Using Oh My ZSH
Download the theme
```bash
$ cd ~/.oh-my-zsh/custom
$ git clone https://github.com/m-lima/simpalt
```
Add the following to your `.zshrc`
```bash
ZSH_THEME="simpalt"
```
#### Using vanilla ZSH
Download the theme
```bash
$ cd
$ git clone https://github.com/m-lima/simpalt
```
Add the following to your `.zshrc`
```bash
source /simpalt.zsh-theme
```
Options
---------------------
##### SIMPALT_SMALL
###### Controls the presentation of the prompt
If set to anything, the prompt will be presented in compact mode; otherwise, the full prompt will be presented.
##### SIMPALT_PROMPT_SEGMENTS
###### Set the prompt segments to be presented
This array will set all segments that compose the prompt.
##### SIMPALT_MAIN_BRANCHES
###### Set the branches that do not require full name
When in a git repository, if the current branch is present in this list, it's name will be omitted.
Available segments:
* prompt_aws
* prompt_status
* prompt_context
* prompt_virtualenv
* prompt_dir prompt_git
### Suggested setup
You can enable quick switch between compact and full mode by registering something similar to the following in your `.zshrc`:
```bash
ts() { [ $SIMPALT_SMALL ] && unset SIMPALT_SMALL || SIMPALT_SMALL=1 }
```
Then, just use the `ts` command to swtich between prompt styles