A Powerline like prompt for Bash, ZSH and Fish. Based on Powerline-Shell by @banga. Ported to golang by @justjanne.
- Shows some important details about the git/hg branch (see below)
- Changes color if the last command exited with a failure code
- If you're too deep into a directory tree, shortens the displayed path with an ellipsis
- Shows the current Python virtualenv environment
- Shows if you are in a nix shell
- It's easy to customize and extend. See below for details.
Table of Contents
All of the version control systems supported by powerline shell give you a quick look into the state of your repo:
- The current branch is displayed and changes background color when the branch is dirty.
- When the local branch differs from the remote, the difference in number
of commits is shown along with
⇡or⇣indicating whether a git push or pull is pending
In addition, git has a few extra symbols:
✎-- a file has been modified, but not staged for commit✔-- a file is staged for commit✼-- a file has conflicts+-- untracked files are present⚑-- stash is present
Each of these will have a number next to it if more than one file matches.
powerline-go uses ANSI color codes, these should nowadays work everywhere,
but you may have to set your $TERM to xterm-256color for it to work.
If you want to use the "patched" mode (which is the default, and provides
improved UI), you'll need to install a powerline font, either as fallback,
or by patching the font you use for your terminal: see
powerline-fonts.
Alternatively you can use "compatible" or "flat" mode.
I provide precompiled binaries for x64 Linux and macOS in the releases tab
- Install (and update) the package with
go get -u github.com/justjanne/powerline-go
- By default it will be in
~/go/bin, if you want to change that, you can set your$GOPATHand/or$GOBIN, but will need to change the path in the following scripts, too.
Add the following to your .bashrc (or .profile on Mac):
function _update_ps1() {
PS1="$(~/go/bin/powerline-go -error $?)"
}
if [ "$TERM" != "linux" ]; then
PROMPT_COMMAND="_update_ps1; $PROMPT_COMMAND"
fi
Add the following to your .zshrc:
function powerline_precmd() {
PS1="$(~/go/bin/powerline-go -error $? -shell zsh)"
}
function install_powerline_precmd() {
for s in "${precmd_functions[@]}"; do
if [ "$s" = "powerline_precmd" ]; then
return
fi
done
precmd_functions+=(powerline_precmd)
}
if [ "$TERM" != "linux" ]; then
install_powerline_precmd
fi
Redefine fish_prompt in ~/.config/fish/config.fish:
function fish_prompt
~/go/bin/powerline-go -error $status -shell bare
end
There are a few optional arguments which can be seen by running
powerline-go -help. These can be used by changing the command you have set
in your shell’s init file.
Usage of powerline-go:
-colorize-hostname
Colorize the hostname based on a hash of itself
-cwd-max-depth int
Maximum number of directories to show in path
(default 5)
-cwd-max-dir-size int
Maximum number of letters displayed for each directory in the path
(default -1)
-cwd-mode string
How to display the current directory
(valid choices: fancy, plain, dironly)
(default "fancy")
-east-asian-width
Use East Asian Ambiguous Widths
-error int
Exit code of previously executed command
-ignore-repos string
A list of git repos to ignore. Separate with ','.
Repos are identified by their root directory.
-max-width int
Maximum width of the shell that the prompt may use, in percent. Setting this to 0 disables the shrinking subsystem.
-mode string
The characters used to make separators between segments.
(valid choices: patched, compatible, flat)
(default "patched")
-modules string
The list of modules to load, separated by ','
(valid choices: aws, cwd, docker, dotenv, exit, git, gitlite, hg, host, jobs, load, nix-shell, perlbrew, perms, root, shell-var, ssh, termtitle, time, user, venv, node)
(default "venv,user,host,ssh,cwd,perms,git,hg,jobs,exit,root")
-newline
Show the prompt on a new line
-numeric-exit-codes
Shows numeric exit codes for errors.
-path-aliases string
One or more aliases from a path to a short name. Separate with ','.
An alias maps a path like foo/bar/baz to a short name like FBB.
Specify these as key/value pairs like foo/bar/baz=FBB.
Use '~' for your home dir. You may need to escape this character to avoid shell substitution.
-priority string
Segments sorted by priority, if not enough space exists, the least priorized segments are removed first. Separate with ','
(valid choices: aws, cwd, cwd-path, docker, exit, git-branch, git-status, hg, host, jobs, load, nix-shell, perlbrew, perms, root, ssh, time, user, venv, node)
(default "root,cwd,user,host,ssh,perms,git-branch,git-status,hg,jobs,exit,cwd-path")
-shell string
Set this to your shell type
(valid choices: bare, bash, zsh)
(default "bash")
-shell-var string
A shell variable to add to the segments.
-shorten-gke-names
Shortens names for GKE Kube clusters.
-theme string
Set this to the theme you want to use
(valid choices: default, low-contrast)
(default "default")
-truncate-segment-width int
Minimum width of a segment, segments longer than this will be shortened if space is limited. Setting this to 0 disables it.
(default 16)
The point of the path aliases feature is to allow you to replace long paths with a shorter string that you can understand more quickly. This is useful if you're often in deep path hierarchies that end up consuming most of your terminal width, even when some portions are replaced by an ellipsis.
For example, you might want to replace the string ~/go/src/github.com with
@GOPATH-GH. When you're in a directory like
~/go/src/github.com/justjanne/powerline-go, you'll instead see @GOPATH-GH > justjanne > powerline-go in the shell prompt.
Aliases are defined as comma-separated key value pairs, like this:
powerline-go ... -path-aliases \~/go/src/github.com=@GOPATH-GH,\~/work/projects/foo=@FOO,\~/work/projects/bar=@BAR
Note that you should use ~ instead of /home/username when specifying the
path. Also make sure to escape the ~ character. Otherwise your shell will
perform interpolation on it before powerline-go can see it!
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.