ivanjonas / cmder-powerline-prompt Goto Github PK

# Cmder-powerline-prompt

This is a custom prompt for [Cmder](http://cmder.net/) (the alternative console emulator for Windows). There's also a [PowerShell version](https://github.com/AmrEldib/cmder-powershell-powerline-prompt) of this prompt.  
It looks like this:  
![screenshot](screenshot.png)

It has a blue background for the prompt.  
For folders with git repos, you get yellow background for changes, and green for clean repos.  
I'm using Consolas font.

The look is inspired by [Powerline for Vim](https://github.com/powerline/powerline), and [Zsh's theme agnoster](https://github.com/agnoster/agnoster-zsh-theme).

# Requirements

Download the [AnonymousPro font](https://github.com/powerline/fonts/tree/master/AnonymousPro)  
You'll be able to use any font in Cmder, but this font contains the symbols included in the prompt. 

## Font
To use another font and still show symbols correctly:  
- Go to Cmder Settings > Main  
- Choose Main console font to be what you prefer  
- Choose _Alternative font_ to be _Anonymice Powerline_  
- Modify the value of _Unicode ranges_ to add: `E0A0; E0B0;`  
- Save Settings  

# Usage

Download the `.lua` file, and place it in `%CMDER_ROOT%/config` folder.  
Restart Cmder to load the prompt.

__Alternatively__, if you want to maintain link with the original repo, you can clone this repo into any folder  
`git clone https://github.com/AmrEldib/cmder-powerline-prompt.git git-repo-folder-name`  
then create a symbolic link from the `%CMDER_ROOT%/config` folder to the `.lua` file.  
```
cd %CMDER_ROOT%/config  
mklink /H cmder-powerline-prompt.lua <git-repo-folder-name>/cmder-powerline-prompt.lua 
```  

## Configuration

You can modify the prompt to display either the full path or only the folder name.  
To do this, modify the value of the `promptValue` variable in the `powerline_prompt.lua` file at [this line](https://github.com/AmrEldib/cmder-powerline-prompt/blob/master/powerline_prompt.lua#L10)  
The value could be either:  
- `promptValueFull` for full path like `C:\Windows\System32`  
- `promptValueFolder` for folder name only like `System32`  

`promptValueFull` is the default.  

# Helpful info for customizing Cmder 

## Links
[Cmder Source Code and README](https://github.com/cmderdev/cmder)  
[What is Clink](https://github.com/mridgers/clink/blob/master/docs/clink.md)  
[Clink API](https://github.com/mridgers/clink/blob/master/docs/api.md)  
[ANSI Color Sequence](http://ascii-table.com/ansi-escape-sequences.php)  

## Cmder Configurations
Cmder configurations is stored in `%CMDER_ROOT%\config\`  
You can add files to be loaded during startup in either of these folders  
        `%CMDER_ROOT%\config\profile.d`  
        `%CMDER_ROOT%\config`  
Add a `.ps1` file to be loaded for Powershell shells  
Add a `.bat` or `.cmd` files to be loaded for Windows Command shells  
Add a `.sh` file to be loaded for Bash shells  
User-specific configurations should go into files named `user-profile` with extensions `ps1`, `cmd`/`bat`, or `sh`.  

## Clink Prompt 
The file `%CMDER_ROOT%\vendor\clink.lua` sets the command prompt. See the function `set_prompt_filter`.
The prompt value is stored in [clink.prompt.value](https://github.com/mridgers/clink/blob/master/docs/api.md#clinkpromptvalue)  
Drop .lua files into the `%CMDER_ROOT%\Config` folder to customize the prompt.

# Status & Contribution
I published this code because it's not nice to keep it to myself. I fix problems that I encounter, and try to fix problems that others encounter if I have time.   
This code is provided with the timeless __Works on my Machine__ gurentee.  
You can also check out the [pull requests page](/pulls) for contributions that didn't make back into this repo. These are fixes to problems I didn't encounter, or features not useful to me, but maybe useful to you.  

People are very kind and contribute back fixes and improvements.  
This section is to acknowledage their contributions and thank them. If you find their contributions helpful to you, please take the time to thank them directly.  
- [omniphx](https://github.com/omniphx) [#2](AmrEldib#2)  
- [umar-ahmed](https://github.com/umar-ahmed) [#6](AmrEldib#6)  
- [tvercruysse](https://github.com/tvercruysse) [#10](AmrEldib#10)  
- [igortg](https://github.com/igortg) [#24](AmrEldib#24)  
- [0NG](https://github.com/0NG) [#27](AmrEldib#27)  
- [mattdkerr](https://github.com/mattdkerr) [#29](AmrEldib#29)  
- [ivanjonas](https://github.com/ivanjonas) [#32](AmrEldib#32)

I'd like to thank all who share their code with everyone for their time and effort.