janoskk/powerline-js

a powerline-style shell prompt builder for node.js

I was using milkbikis's excellent powerline-style shell prompt when I decided that I wanted more options. Then I wanted a version in javascript instead of python so I could add those options myself in my current programming environment of choice. Then I started rewriting it. Then I observed that it was faster in javascript than in python, probably because node.js starts up really quickly.

This is the tragic result: a powerline-style shell prompt generator for node.

The last segment of the prompt shows the git branch active, if you're in a git repo. Repos with uncommitted modifications are shown in red. If there are untracked files, a + is added. If you have unpushed changes, there's an ⇡ with the change count. If the upstream repo has changes you've fetched but not yet merged, there's a ⇣ with the count of how many you're behind.

Installation

npm install powerline should install powerline in your node path. Or clone the repo & symlink powerline.js to some location in your path.

Then go to the original most excellent project page and find a patched font you like.

Usage

Use it as you would the original. E.g, for bash:

function _update_ps1() {
   export PS1="$(~/bin/powerline.js $? --shell bash --depth 4)"
}
export PROMPT_COMMAND="_update_ps1"

For zsh:

function powerline_precmd()
{
   export PS1="$(~/bin/powerline.js $?)"
}
precmd_functions=(powerline_precmd)

Options

--shell [zsh|bash]
: which shell to emit color escapes for; defaults to 'zsh'

--cwd-only
: use only the current working directory in the prompt; defaults to false

--mode [patched|compatible]
: which font mode to expect; defaults to 'patched'

--depth *N*
: how many segments of the current working directory to show; defaults to 5

--no-repo
: do not attempt to show extra source repository information for the current directory; defaults to false

--repo-only
: generate only a source repository segment; defaults to false

Any further arguments are presumed to be $? aka the error returned by the previous shell command.

No mercurial support yet and the svn support isn't good, but then, you're using git anyway. Note that I default to zsh because that's how I roll, but the original defaults to bash.

Customize the colours

Use the following environment variables in order to override the default segment colours:

segment	environment variable
path	POWERLINE_PATH_BG, POWERLINE_PATH_FG, POWERLINE_CWD_FG, POWERLINE_SEPARATOR_FG
git repo status	POWERLINE_REPO_CLEAN_BG, POWERLINE_REPO_CLEAN_FG, POWERLINE_REPO_DIRTY_BG, POWERLINE_REPO_DIRTY_FG
command status	POWERLINE_CMD_PASSED_BG, POWERLINE_CMD_PASSED_FG, POWERLINE_CMD_FAILED_BG, POWERLINE_CMD_FAILED_FG
subversion status	POWERLINE_SVN_CHANGES_BG, POWERLINE_SVN_CHANGES_FG
virtual python environment name	POWERLINE_VIRTUAL_ENV_BG, POWERLINE_VIRTUAL_ENV_FG

Example:

# Configure powerline
export POWERLINE_REPO_CLEAN_BG=149
export POWERLINE_REPO_CLEAN_FG=0
export POWERLINE_REPO_DIRTY_BG=160
export POWERLINE_REPO_DIRTY_FG=250

Other shells?

Sure. Supporting new shells should be as simple as supporting their color escape sequences by adding to this hash:

var COLOR_TEMPLATES =
{
	'bash': function(s) { return '\\[\\e' + s + '\\]'; },
	'zsh': function(s) { return '%{�' + s + '%}'; }
};

TODO

• An option to reverse the prompt direction, for use in zsh right prompts.
• Mercurial support.
• Optional timestamp segment.

License

MIT.