https://github.com/andresgongora/synth-shell-prompt
Customize your terminal with colors, extra system information, and eyecandy
https://github.com/andresgongora/synth-shell-prompt
Last synced: 6 months ago
JSON representation
Customize your terminal with colors, extra system information, and eyecandy
- Host: GitHub
- URL: https://github.com/andresgongora/synth-shell-prompt
- Owner: andresgongora
- License: gpl-3.0
- Created: 2020-04-17T21:47:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-04T08:34:54.000Z (about 2 years ago)
- Last Synced: 2025-11-27T13:46:14.764Z (7 months ago)
- Language: Shell
- Homepage:
- Size: 659 KB
- Stars: 57
- Watchers: 1
- Forks: 19
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
- awesome-cli-apps-in-a-csv - synth-shell-prompt - A small eye-candy shell prompt with Git status displaying, a clock, intelligent $PWD shortening, and much more. (<a name="prompt"></a>Prompts)
- awesome-cli-apps - synth-shell-prompt - A small eye-candy shell prompt with Git status displaying, a clock, intelligent $PWD shortening, and much more. (<a name="prompt"></a>Prompts)
README
This script is part of [synth-shell](https://github.com/andresgongora/synth-shell)
**synth-shell-prompt** formats your terminal's prompt as
shown in the figure below. However, it's not all eye-candy but also useful information:
- Git statuses (requires pull/push, is dirty, etc.) if inside a directory that
is part of a git repository.
- Better separation between user input and command outputs.
- Configurable colors and aesthetics.
- PyEnv aware.
- Intelligent $PWD shortening.
- And much more!
# Setup
### Arch Linux
You may install `synth-shell-prompt` from AUR:
https://aur.archlinux.org/packages/synth-shell-prompt-git/
Once installed, test it with:
```
. /usr/bin/synth-shell-prompt
```
And if you like it, add it permanently to your terminal with:
```
echo ". /usr/bin/synth-shell-prompt" >> ~/.bashrc
```
### Manual setup
The included [setup script](setup.sh) will guide you step by step through the
installatioj process. Just clone this repository and run it:
```
git clone --recursive https://github.com/andresgongora/synth-shell-prompt.git
synth-shell-prompt/setup.sh
```
Then install the required fonts packages to display the triangle separators properly:
- ArchLinux: sudo pacman -S powerline-fonts
- Debian/Ubuntu: sudo apt install fonts-powerline
You can then test your script by sourcing it from wherever you installed it.
Usually this is to your user's `.config` folder, so you should run the following
command. Notice the `.`, this is meant to source the script to your
terminal session (i.e. include it into your session).
```
. ~/.config/synth-shell/synth-shell-prompt.sh
```
If you want it to appear everytime you open a new terminal, run either
```
echo ". ~/.config/synth-shell/synth-shell-prompt.sh" >> ~/.bashrc
```
### Configuration/customization
You can configure your scripts by modifying the corresponding configuration
files. You can find them, along example configuration files, in the following
folders depending on how you installed **synth-shell**:
* Current-user only: `~/.config/synth-shell/`
* System wide: `/etc/synth-shell/`
#### Command in new line
In addition to having the command-line right after the prompt, it is possible to set-up **synth-shell** to instead display the command on the next line, which looks like this:
This can be achieved by changing the option `enable_command_on_new_line=false` to `enable_command_on_new_line=true` on the `MAIN FORMAT` section of the `synth-shell-prompt.config` file.
# Overview
`fancy-bash-prompt.sh` Adds colors and triangular separators to your bash
prompt, and if the current working directory is part of a git repository,
also git statuses and branches.
For best results, consider installing (and telling your terminal to use)
the `hack-ttf` font alongside the powerline-fonts (the later is required for
the separators).
As for the git status info, `fancy-bash-prompt.sh` prints an additional, fourth
separator with the name of the current branch and one of the following icons
to indicate the state of the repository (can be changed in the config file):
| Local-Upstream | Local branch has no changes | Local branch is dirty |
|:--------------------------------:|:---------------------------:|:---------------------:|
| Up to date | | □ |
| Ahead (you have to push) | ▲ | △ |
| Behind (you have to pull) | ▼ | ▽ |
| Diverged (you have to pull-push) | ● | ○ |
# Contribute
This project is only possible thanks to the effort and passion of many,
including developers, testers, and of course, our beloved coffee machine.
You can find a detailed list of everyone involved in the development
in [AUTHORS.md](AUTHORS.md). Thanks to all of you!
If you like this project and want to contribute, you are most welcome to do so.
### Help us improve
* [Report a bug](https://github.com/andresgongora/synth-shell/issues/new/choose):
if you notice that something is not right, tell us. We'll try to fix it ASAP.
* Suggest an idea you would like to see in the next release: send us
and email or open an [issue](https://github.com/andresgongora/synth-shell/issues)!
* Become a developer: fork this repo and become an active developer!
Take a look at the [issues](https://github.com/andresgongora/synth-shell/issues)
for suggestions of where to start. Also, take a look at our
[coding style](coding_style.md).
* Spread the word: telling your friends is the fastes way to get this code to
the people who might enjoy it!
# About
**synth-shell-prompt** is part of
[synth-shell](https://github.com/andresgongora/synth-shell)
# License
Copyright (c) 2014-2023, Andres Gongora - www.andresgongora.com
* This software is released under a GPLv3 license.
Read [license-GPLv3.txt](LICENSE),
or if not present, .
* If you need a closed-source version of this software
for commercial purposes, please contact the [authors](AUTHORS.md).