Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/AmrEldib/cmder-powerline-prompt

Custom prompt for Cmder on Windows
https://github.com/AmrEldib/cmder-powerline-prompt

cmder conemu windows-command-line

Last synced: 3 months ago
JSON representation

Custom prompt for Cmder on Windows

Awesome Lists containing this project

README 

        
# Status (Dec. 2022)



Sometime in 2019, I've switched from Windows to Linux and stopped using Cmder on daily basis.  

Since the new [Windows Terminal](https://github.com/microsoft/terminal) became available, I've also stopped using Cmder on my work machine.  

**This project is no longer updated**.  

For an alternative, check out [oh-my-posh](https://ohmyposh.dev/)  

For a Cmder alternative, please read the [Status and Contributions section](#status--contributions) and check out the [pull requests](https://github.com/AmrEldib/cmder-powerline-prompt/pulls) and the [list of forks](https://github.com/AmrEldib/cmder-powerline-prompt/network/members)  

Thank you all!



# 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)



The prompt has multiple segments:  

- Folder: in blue. Displays the folder name, or full path. Replaces the user's home folder with a tilde (~).  

- npm: in teal. If it detects an npm package, it displays the package name and version number.  

- Git: in green or yellow. If it detects a Git repo, it displays the branch name. A green color is used if no changes are detected. A yellow color is used if changes are found.  



In the screenshot, [Fira Code](https://github.com/tonsky/FiraCode) font is used.  



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;`

  * for extra symbols set in `_powerline_config.lua` (like npm logo for node module or git project for smart path resolving) set the _Alternative font_ to one of your choosing.

    ![screenshot](screenshot_fonts.png)

  * The [Icomoon](https://icomoon.io/) includes npm and git symbols. You might find [nerd-fonts](https://github.com/ryanoasis/nerd-fonts) helpful as well.  

* Save Settings



# Setup



Download the `.lua` files, 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.



```bat

cd %CMDER_ROOT%/config  

mklink /H powerline_core.lua /powerline_core.lua

mklink /H powerline_prompt.lua /powerline_prompt.lua

```



To add Git prompt, add the Git file



```bat

mklink /H powerline_git.lua /powerline_git.lua

```



To add Configurations, create a file named `_powerline_config.lua` that is a copy of the file `_powerline_config.lua.sample`



To add symbolic links across drives (from C drive pointing to D drive, for example), use PowerShell instead of `mklink`.  

```powershell

new-item -path powerline_core.lua -itemtype symboliclink -value \cmder-powerline-prompt\powerline_core.lua

```



## Configuration



Config file is `_powerline_config.lua`. This file isn't created by default to avoid overwrite on future updates.  

A sample config file is included: `_powerline_config.lua.sample`



See the file `_powerline_config.lua.sample` for full list and details of configurations.  



# Helpful info for customizing Cmder



## Links



[Cmder Source Code and README](https://github.com/cmderdev/cmder)  

[What is Clink](https://github.com/AmrEldib/cmder-powerline-prompt/blob/master/docs/clink.md)  

[Clink Lua API](https://github.com/AmrEldib/cmder-powerline-prompt/blob/master/docs/clink_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 & Contributions



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** guarantee.  

You can also check out the [pull requests page](https://github.com/AmrEldib/cmder-powerline-prompt/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.  

Some of these contributions are:  

- [Show active Python Virtual Environment](https://github.com/AmrEldib/cmder-powerline-prompt/issues/5)  

- [Add Python's VENV support](https://github.com/AmrEldib/cmder-powerline-prompt/pull/21)  



People are very kind and contribute back fixes and improvements.  

This section is to acknowledge 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](https://github.com/AmrEldib/cmder-powerline-prompt/pull/2)

* [umar-ahmed](https://github.com/umar-ahmed) [#6](https://github.com/AmrEldib/cmder-powerline-prompt/pull/6)

* [tvercruysse](https://github.com/tvercruysse) [#10](https://github.com/AmrEldib/cmder-powerline-prompt/pull/10)

* [igortg](https://github.com/igortg) [#24](https://github.com/AmrEldib/cmder-powerline-prompt/pull/24)

* [0NG](https://github.com/0NG) [#27](https://github.com/AmrEldib/cmder-powerline-prompt/pull/27)

* [mattdkerr](https://github.com/mattdkerr) [#29](https://github.com/AmrEldib/cmder-powerline-prompt/pull/29)

* [ivanjonas](https://github.com/ivanjonas) [#32](https://github.com/AmrEldib/cmder-powerline-prompt/pull/32)

* [sp3c1](https://github.com/sp3c1) contributed the npm addon [#33](https://github.com/AmrEldib/cmder-powerline-prompt/pull/33)  

* [Bob Hood](https://github.com/b0bh00d) contributed the new Mercurial addon [#40](https://github.com/AmrEldib/cmder-powerline-prompt/pull/40)  



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



# Writing an addon  

This prompt uses an addon architecture to allow for additional functionality.  

`powerline_prompt.lua` is a good example for how to write an addon. The code is annotated and explains how to write a new addon.  

To write a new addon, create a new `lua` file in `%CMDER_ROOT%/config`. Start a new tab in Cmder to see the effect of changes.