Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dannynimmo/punctual-zsh-theme
Punctual, a Zsh prompt theme
https://github.com/dannynimmo/punctual-zsh-theme
zsh zsh-theme
Last synced: 2 months ago
JSON representation
Punctual, a Zsh prompt theme
- Host: GitHub
- URL: https://github.com/dannynimmo/punctual-zsh-theme
- Owner: dannynimmo
- License: mit
- Created: 2016-07-31T10:39:32.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T23:31:01.000Z (over 1 year ago)
- Last Synced: 2024-01-27T12:11:38.598Z (5 months ago)
- Topics: zsh, zsh-theme
- Language: Shell
- Size: 62.5 KB
- Stars: 51
- Watchers: 4
- Forks: 20
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-zsh-plugins - punctual - Easily customizable, influenced by [spaceship](https://github.com/denysdovhan/spaceship-prompt). (Themes / ZSH on Windows)
- awesome-zsh-plugins - punctual - Easily customizable, influenced by [spaceship](https://github.com/denysdovhan/spaceship-prompt). (Themes / Zinit (nÊe zplugin))
- awesome-zsh-plugins - punctual - Easily customizable, influenced by [spaceship](https://github.com/denysdovhan/spaceship-prompt). (Themes / ZSH on Windows)
- awesome-stars - dannynimmo/punctual-zsh-theme - Punctual, a Zsh prompt theme (Shell)
- fucking-awesome-zsh-plugins - punctual - Easily customizable, influenced by <b><code> 19221â</code></b> <b><code> 964đ´</code></b> [spaceship](https://github.com/denysdovhan/spaceship-prompt)). (Themes / ZSH on Windows)
README
# Punctual, a Zsh prompt theme
Add a bit of flavour to your prompt! My personal Zsh prompt theme, influenced heavily by [denysdovhan](https://github.com/denysdovhan)'s [Spaceship theme](https://github.com/denysdovhan/spaceship-zsh-theme).
## Features
* Customisable colours & output
* Git branch & status display
* Username turns red when root
* Prompt turns red if the last command finishes with non-zero exit code
## Installation
In the screenshot above I'm using [Solarized colours](https://github.com/altercation/solarized/tree/master/iterm2-colors-solarized) for [iTerm2](https://www.iterm2.com/), along with the [Inconsolata font](https://www.google.com/fonts/specimen/Inconsolata).
### Oh My Zsh
1. Download [punctual.zsh-theme](https://raw.githubusercontent.com/dannynimmo/punctual-zsh-theme/v0.1.0/punctual.zsh-theme) into your custom theme directory, `$ZSH_CUSTOM/themes`
2. Update `ZSH_THEME="punctual"` in your `~/.zshrc`
3. Open a new terminal to see the theme
### Antigen
Include the following line to `~/.zshrc` as part of your antigen setup (after any [configuration settings](#configuration)).
```zsh
antigen theme dannynimmo/punctual-zsh-theme punctual
```
## Configuration
By setting variables before loading the theme, you can customise the output format of Punctual.
### Hiding parts
Set any of the following variables to `"false"` to hide the output.
```zsh
PUNCTUAL_SHOW_BLANK_LINE="false";
PUNCTUAL_SHOW_TIMESTAMP="false";
PUNCTUAL_SHOW_USER="false";
PUNCTUAL_SHOW_HOSTNAME="false";
PUNCTUAL_SHOW_CURRENT_DIR="false";
PUNCTUAL_SHOW_GIT="false";
```
### Colours
Set any of the following variables to one of the 8 ANSI colour names.
```zsh
PUNCTUAL_TIMESTAMP_COLOUR="red";
PUNCTUAL_USER_COLOUR="green";
PUNCTUAL_ROOT_USER_COLOUR="yellow";
PUNCTUAL_HOSTNAME_COLOUR="blue";
PUNCTUAL_CURRENT_DIR_COLOUR="magenta";
PUNCTUAL_GIT_COLOUR="cyan";
```
Possible values are:
* `black`
* `red`
* `green`
* `yellow`
* `blue`
* `magenta`
* `cyan`
* `white`
### Bold fonts
Set any of the following variables to `"true"` to use the terminal's bold font.
```zsh
PUNCTUAL_TIMESTAMP_BOLD="true";
PUNCTUAL_USER_BOLD="true";
PUNCTUAL_ROOT_USER_BOLD="true";
PUNCTUAL_HOSTNAME_BOLD="true";
PUNCTUAL_CURRENT_DIR_BOLD="true";
PUNCTUAL_GIT_BOLD="true";
```
### Timestamp format
Set the below variable to customise the timestamp format. See [`man strftime`](http://man7.org/linux/man-pages/man3/strftime.3.html) for format options.
```zsh
PUNCTUAL_TIMESTAMP_FORMAT="%l:%M%P";
```
### Prompt symbol
Set the below variable to your favourite prompt symbol (or emoji đ
).
```zsh
PUNCTUAL_PROMPT="$";
```
### Git status symbols
If you already have your `ZSH_THEME_GIT_PROMPT_*` variables set, Punctual will respect those. Alternatively, set the following variables to customise the Git status symbols.
```zsh
PUNCTUAL_GIT_SYMBOL_UNTRACKED="?";
PUNCTUAL_GIT_SYMBOL_ADDED="+";
PUNCTUAL_GIT_SYMBOL_MODIFIED="!";
PUNCTUAL_GIT_SYMBOL_RENAMED="!";
PUNCTUAL_GIT_SYMBOL_DELETED="!";
PUNCTUAL_GIT_SYMBOL_STASHED="*";
PUNCTUAL_GIT_SYMBOL_UNMERGED="M";
PUNCTUAL_GIT_SYMBOL_AHEAD="â";
PUNCTUAL_GIT_SYMBOL_BEHIND="â";
PUNCTUAL_GIT_SYMBOL_DIVERGED="~";
```
### Python environments
The Python environment being used (conda or virtualenvironment) will be added if the following flag is set to true (false by default) in your `.zshrc`:
```zsh
PUNCTUAL_SHOW_PYTHON_ENVIRONMENT=true
```
For conda, run the following command to disable the prompt that appears at the start of the line by default:
```zsh
conda config --set changeps1 False
```zsh
And similarly for python virtual environments you can add (either of) the following commands to your .zshrc to disable the prompt:
```zsh
export VIRTUAL_ENV_DISABLE_PROMPT=1;
export PYENV_VIRTUALENV_DISABLE_PROMPT=1;
```
## Changelog
### [0.4.0](https://github.com/dannynimmo/punctual-zsh-theme/releases/tag/v0.4.0) â 2022-12-12
* Added Python support
### [0.3.0](https://github.com/dannynimmo/punctual-zsh-theme/releases/tag/v0.3.0) â 2020-11-19
* Added ability to disable the initial new line
### [0.2.0](https://github.com/dannynimmo/punctual-zsh-theme/releases/tag/v0.2.0) â 2016-09-16
* Added ability to use bold fonts
### [0.1.0](https://github.com/dannynimmo/punctual-zsh-theme/releases/tag/v0.1.0) â 2016-08-01
* Released!