<h1 align="center">Jovial</h1> <img src="https://img.shields.io/badge/-macOS-000000?logo=Apple&logoColor=ffffff" alt="Platform macOS" /> <img src="https://img.shields.io/badge/-WSL-0078D4?logo=windows11&logoColor=ffffff" alt="Platform WSL" /> <img src="https://img.shields.io/badge/-Debian-A80030?logo=debian&logoColor=ffffff" alt="Platform Debian" /> <img src="https://img.shields.io/badge/-Ubuntu-E95420?logo=ubuntu&logoColor=ffffff" alt="Platform Ubuntu" /> <img src="https://img.shields.io/badge/-CentOS-262577?logo=centos&logoColor=ffffff" alt="Platform CentOS" /> <img src="https://img.shields.io/badge/-Rocky%20Linux-10B981?logo=rockylinux&logoColor=ffffff" alt="Platform Rocky Linux"> <img src="https://img.shields.io/badge/-Arch%20Linux-1793D1?logo=archlinux&logoColor=ffffff" alt="Platform Arch Linux" /> A clean and fast ZSH theme with responsive design, providing simple yet powerful features

Overview

Jovial is designed for users who want a straightforward ZSH experience without unnecessary complexity. Whether you're new to ZSH or an experienced user, Jovial offers an intuitive interface with helpful features that enhance your command-line workflow.

·　 <a href="#features--preview">Features</a> 　/　 <a href="#plugins-integration">Plugins</a> 　/　 <a href="#install">Install</a> 　/　 <a href="#customization">Customization</a> 　/　 <a href="#benchmark">Benchmark</a> 　/　 <a href="#migration">Migration</a> 　·

Features & Preview

Complete Feature Set

Jovial comes packed with useful features. Here's how it looks with all features enabled:

The description of each part:

Responsive Design

Each part of the prompt is "responsive" to the terminal window's width, so you can safely use it in a narrow terminal.

<div><video controls muted autoplay loop src="https://user-images.githubusercontent.com/15135943/148246834-08ecbbfc-6d0e-4c25-96b5-3638b32a4a28.mp4"></video></div>

Git Actions State

In addition to the basic git state (branch / tag / hash, dirty or clean),

there are also some prompts to hint that you are in merge / rebase / cherry-pick now with conflict or not.

Note that all git states will be updated asynchronously, so this theme is pretty fast even in a huge git repo.

Development Environment Detection

It will detect and show your development programming language and version in the current working directory,

support Python, Conda, NodeJs, Golang, PHP out-of-box, such as:

venv environment for Python:

Support detecting the venv, virtualenv, conda environment activated by default.

For conda (miniconda), you need set conda config --set changeps1 false to avoid conda auto change the theme's prompt.

Show Execution Elapsed Time

Plugins Integration

These integrated plugins below will be auto-setup by the install script. You can see the install.zsh-plugins function in installer.sh

jovial: Jovial plugin defines some utility functions and aliases. You can see them in jovial.plugin.zsh
git: Short aliases for commonly used commands
zoxide: It remembers which directories you use most frequently, so you can "jump" to them in just a few keystrokes.
bgnotify: Background notifications for long-running commands
zsh-history-enquirer: Widget for history searching, enhances Ctrl+R
zsh-autosuggestions: Shell auto-completion
zsh-syntax-highlighting: User input syntax highlighting

Install

Just run the simple one-line install command:

curl -sSL https://github.com/zthxxx/jovial/raw/master/installer.sh | sudo -E bash -s ${USER:=`whoami`}

Note: The install script is designed to be "Idempotent", so you can safely execute it multiple times.

Tips: You may want to use some http proxy. Just export proxy variables before running the install command,

　　like: export all_proxy=http://127.0.0.1:1086

　　(it's equal to export http_proxy=http://127.0.0.1:1086 http_proxys=http://127.0.0.1:1086)

Here is what the install command and script do:

Explain the command:
- sudo: Ensures the script runs with access to install packages and change the default login shell
- -E: Passes through environment variables while using sudo, to receive variables like http_proxy
- -s $USER: Passes the parameters to the script, which is the real target user for installation
The script performs these steps:
- If zsh or oh-my-zsh is not found, it will install them
- Changes the default login shell to zsh
- Downloads the jovial theme/plugin files in the oh-my-zsh custom folder
- Installs integrated plugins via the local package manager
- Automatically rewrites the ZSH_THEME and plugins variables in the user's .zshrc

Install with Zinit

Zinit is a fast plugin manager for zsh with simple declarative configuration.

Install Jovial and its plugins with just a single line in your .zshrc:

zinit light-mode depth=1 multisrc='*.plugin.zsh' for zthxxx/jovial

See the full out-of-the-box Zinit config here:

https://github.com/zthxxx/jovial/blob/master/examples/zinit.zshrc

Use this example .zshrc as a starter:

curl -SL https://github.com/zthxxx/jovial/raw/master/examples/zinit.zshrc -o ~/.zshrc

Install with Antigen

Antigen is a theme/plugin manager for zsh that uses simple declarative configuration.

With Antigen, installing Jovial without sudo permission is easy.

Just download Antigen and copy the example below into your ~/.zshrc, reload zsh, and Antigen will automatically download everything only during initialization.

Download Antigen:

mkdir -p ~/.antigen && curl -SL https://github.com/zsh-users/antigen/raw/develop/bin/antigen.zsh -o ~/.antigen/antigen.zsh

Example for ~/.zshrc with Antigen:

You can manually copy this below into your ~/.zshrc file, or use the command to download and append:

curl -SL https://github.com/zthxxx/jovial/raw/master/examples/antigen.zshrc >> ~/.zshrc

# ~/.zshrc

# [Antigen](https://github.com/zsh-users/antigen), 
# a theme/plugin manager for zsh that uses simple declarative configuration.

# Load Antigen
source ~/.antigen/antigen.zsh

# Basic recommended for Antigen
antigen use oh-my-zsh
antigen bundle git
antigen bundle zoxide
antigen bundle colored-man-pages
antigen bundle zsh-users/zsh-completions
antigen bundle zsh-users/zsh-autosuggestions
antigen bundle zsh-users/zsh-syntax-highlighting

# Load the Jovial theme and plugins
antigen theme zthxxx/jovial
antigen bundle zthxxx/jovial
antigen bundle zthxxx/zsh-history-enquirer


# Any other plugins need to be set before `antigen apply`

# After all, tell Antigen that you're done, then Antigen will start
antigen apply

Then reload zsh to load Antigen with the Jovial theme:

exec zsh -il

Note that you also need to manually install other plugin bin files like:

sudo apt install -y zoxide terminal-notifier source-highlight

Install with Fig

Fig adds apps, shortcuts, and autocomplete to your existing terminal.

Install the jovial theme in just one click.

Manually Install Without oh-my-zsh

First, you need to download the jovial.zsh-theme file manually. For example, using curl:

curl -sSL "https://github.com/zthxxx/jovial/raw/master/jovial.zsh-theme" -o ~/.config/jovial.zsh-theme

Then, add these zsh settings in your ~/.zshrc and load the theme file:

# ~/.zshrc

source ~/.config/jovial.zsh-theme

Finally, don't forget to change the default login shell to zsh. You can use the chsh command:

sudo chsh -s `command -v zsh` $USER

Upgrade

Using Antigen

With Antigen, it's simple to update the jovial theme by using antigen update:

antigen update zthxxx/jovial

Note that this ONLY updates the jovial theme, without any ot

Jovial

Install / Use

README