https://github.com/mje-nz/zsh-themes

Minimal, fast zsh themes
https://github.com/mje-nz/zsh-themes

Last synced: about 1 month ago
JSON representation

Minimal, fast zsh themes

• Host: GitHub
• URL: https://github.com/mje-nz/zsh-themes
• Owner: mje-nz
• License: other
• Created: 2019-10-27T03:25:57.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-03-20T22:38:14.000Z (almost 3 years ago)
• Last Synced: 2024-04-16T17:36:35.883Z (8 months ago)
• Language: Shell
• Homepage:
• Size: 193 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: License.txt

Awesome Lists containing this project

README

        
# Minimal, fast zsh themes

![screenshot](img/screenshot.png)

## Features

* Shows username and hostname, but only when you're not on your usual machine

* Shows working directory with interleaved git state

* Intelligently shortens long working directories

* Shows return value after commands that return an error code

* Shows number of background jobs

* Shows execution time after long-running commands

* Shows current Python virtualenv

* Optional asynchronous mode for faster prompts inside git repos

### Git integration

The basics from left to right: branch (master), number of commits ahead (1↑), number of commits behind (1↓), indicators for untracked/modified/staged.

![Screenshot showing basic git status](img/screenshot-git.png)

Detached head warning, non-head-branch (master\~2), active merge/rebase indicator (⚡︎).

![Screenshot showing git status during a merge](img/screenshot-git2.png)

Bisecting:

![Screenshot showing git status during bisection](img/screenshot-git3.png)

Submodules or nested repos:

![Screenshot showing git status inside a submodule](img/screenshot-git4.png)

## Installation

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

Add this to your `~/.zshrc` with your other plugins, after loading oh-my-zsh:

```zsh

  zgen load mafredri/zsh-async

  zgen load mje-nz/zsh-themes async

  # or to disable asynchronous mode

  zgen load mje-nz/zsh-themes simple

```

### For [antigen](https://github.com/zsh-users/antigen) users (untested)

Add this to your `~/.zshrc` somewhere after loading oh-my-zsh:

```zsh

antigen bundle mafredri/zsh-async

antigen theme https://github.com/mje-nz/zsh-themes async

```

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

Add this to your `~/.zshrc` with your other plugins:

```zsh

zplug mafredri/zsh-async, from:github

setopt prompt_subst

zplug "mje-nz/zsh-themes", use:async.zsh-theme, defer:3

```

## Configuration

See the top of `src/prompt_common.zsh` for configuration variables; to change them, export them in your `.zshrc`.