Mirage

A simple shell theme

Features

Exit code visualization
User with sudo validitity visualization
Host
Current directory
Git branch and changes

Installation

Clone this repository to your desired location with git clone --depth=1 https://github.com/robin-pfeiffer/mirage.git (in this example ~/Projects/github/robin-pfeiffer/mirage was used).

Source use-mirage.*sh, based on your shell (Bash, ZSH, etc.), from the location you cloned the repository into, in your shell's .*rc file to alter PS1:

# .bashrc
source "$HOME/Projects/github/robin-pfeiffer/mirage/use-mirage.bash"

# .zshrc
source "$HOME/Projects/github/robin-pfeiffer/mirage/use-mirage.zsh

Apply the changes by sourcing your .*rc file or by restarting your current terminal.

Configuration

Mirage provides basic configuration of certain features and prompt build-up.

`MIRAGE_ESCAPE_CHARACTER_BEGIN`

String, default: \[

Beginning escape character to use for colour blocks. Change this to %{ for ZSH support with export MIRAGE_ESCAPE_CHARACTER_BEGIN="%{.

`MIRAGE_ESCAPE_CHARACTER_END`

String, default: %}

Ending escape character to use for colour blocks. Change this to %} for ZSH support with export MIRAGE_ESCAPE_CHARACTER_END="%}.

`MIRAGE_SHOW_SUDO`

true or false, default: true

When true shows the validity of sudo for the current session by colouring the user red instead of blue.

`MIRAGE_SEGMENTS`

Segmented string, default: "exit_code user host dir scm"

Add or remove segments from the prompt being used.

Updating

Pull the latest changes from this repository with git pull --ff-only, and source your shell's .*rc file to apply the changes.

Development

Shell files in this respository are validated with ShellCheck. After making changes to any shell files, run ShellCheck to validate these changes. See ShellCheck for information about installation and usage.

When making changes to the prompt, always make sure that the combination of default segments results in a logical English sentence.

License

Distributed under MIT License. See LICENSE for more information.