Repository files navigation

Cmder is asoftware package created out of pure frustration over absence of usable console emulator on Windows. It is based onConEmu withmajor config overhaul, comes with a Monokai color scheme, amazingclink (further enhanced byclink-completions) and a custom prompt layout.

The main advantage of Cmder is portability. It is designed to be totally self-contained with no external dependencies, which makes it great forUSB Sticks orcloud storage. So you can carry your console, aliases and binaries (likewget,curl andgit) with you anywhere.

The Cmder's user interface is also designed to be more eye pleasing, and you can compare the main differences between Cmder and ConEmuhere.

1. Download thelatest release
2. Extract the archive.Note: This path should not beC:\Program Files or anywhere else that would require Administrator access for modifying configuration files
3. (optional) Place your own executable files into the%cmder_root%\bin folder to be injected into your PATH.
4. RunCmder.exe

1. Download thelatest release
2. Extract the archive to a shared location.
3. (optional) Place your own executable files and custom app folders into the%cmder_root%\bin. See:bin/README.md
   • This folder to be injected into your PATH by default.
   • See/max_depth [1-5] in 'Command Line Arguments forinit.bat' table to add subdirectories recursively.
4. (optional) Place your own custom app folders into the%cmder_root%\opt. See:opt/README.md
   • This folder will NOT be injected into your PATH so you have total control of what gets added.
5. RunCmder.exe with/C command line argument. Example:cmder.exe /C %userprofile%\cmder_config

   • This will create the following directory structure if it is missing.

     c:\users\[username]\cmder_config├───bin├───config│   └───profile.d└───opt

• (optional) Place your own executable files and custom app folders into%userprofile%\cmder_config\bin.
  • This folder to be injected into your PATH by default.
  • See/max_depth [1-5] in 'Command Line Arguments forinit.bat' table to add subdirectories recursively.
• (optional) Place your own custom app folders into the%user_profile%\cmder_config\opt.
  • This folder will NOT be injected into your PATH so you have total control of what gets added.

• Both the shared install and the individual user config locations can contain a full set of init and profile.d scripts enabling shared config with user overrides. See below.

So you've experimented with Cmder a little and want to give it a shot in a more permanent home;

1. Open a terminal as an Administrator
2. Navigate to the directory you have placed Cmder
3. Execute.\cmder.exe /REGISTER ALLIf you get an "Access Denied" message, make sure you are executing the command in anAdministrator prompt.

In a file explorer window right click in or on a directory to see "Cmder Here" in the context menu.

• Ctrl +T : New tab dialog (maybe you want to open cmd as admin?)
• Ctrl +W : Close tab
• Ctrl +D : Close tab (if pressed on empty command)
• Shift +Alt +#Number : Fast new tab:1 - CMD,2 - PowerShell
• Ctrl +Tab : Switch to next tab
• Ctrl +Shift +Tab : Switch to previous tab
• Ctrl +#Number : Switch to tab #Number
• Alt +Enter: Fullscreen

• Ctrl +Alt +U : Traverse up in directory structure (lovely feature!)
• End,Home,Ctrl : Traversing text with as usual on Windows
• Ctrl +R : History search
• Shift + Mouse : Select and copy text from buffer

(Some shortcuts are not yet documented, though they exist - please document them here)

You can open multiple tabs each containing one of the following shells:

Cmder, PowerShell, and Bash tabs all run on top of the Windows Console API and work as you might expect in Cmder with access to use ConEmu's color schemes, key bindings and other settings defined in the ConEmu Settings dialog.

⚠Note: Only the full edition of Cmder comes with a pre-installed bash, using a vendoredgit-for-windows installation. The pre-configured Bash tabs may not work on Cmder mini edition without additional configuration.

You may however, choose to use an external installation of bash, such as Microsoft'sSubsystem for Linux (called WSL) or theCygwin project which provides POSIX support on windows.

⚠Note: Mintty tabs use a program called 'mintty' as the terminal emulator that is not based on the Windows Console API, rather it's rendered graphically by ConEmu. Mintty differs from the other tabs in that it supports xterm/xterm-256color TERM types, and does not work with ConEmu settings like color schemes and key bindings. As such, some differences in functionality are to be expected, such as Cmder not being able to apply a system-wide configuration to it.

As a result mintty specific config is done via the[%USERPROFILE%|$HOME]/.minttyrc file. You may read more about Mintty and its config filehere.

An example of setting Cmder portable terminal colors for mintty:

From a bash/mintty shell:

cd $CMDER_ROOT/vendorgit clone https://github.com/karlin/mintty-colors-solarized.gitcd mintty-colors-solarized/echo source \$CMDER_ROOT/vendor/mintty-colors-solarized/mintty-solarized-dark.sh>>$CMDER_ROOT/config/user_profile.sh

You may find some Monokai color schemes for mintty to match Cmderhere.

The default Cmder shellcmd::Cmder prompt is customized usingClink and is configured by editing a config file that exists in one of two locations:

• Single User Portable Config%CMDER_ROOT%\config\cmder_prompt_config.lua
• Shared Cmder install with Non-Portable Individual User Config%CMDER_USER_CONFIG%\cmder_prompt_config.lua

If your Cmder setup does not have this file create it from%CMDER_ROOT%\vendor\cmder_prompt_config.lua.default

Customizations include:

• Colors.
• Single/Multi-line.
• Full path/Folder only.
• [user]@[host] to the beginning of the prompt.
• ~ for home directory.
• λ symbol

Documentation is in the file for each setting.

1. PressWin +Alt +T
2. Click either:

• 1. {cmd::Cmder as Admin}
• 2. {cmd::Cmder}

1. Add command line arguments where specified below:

Note: Pay attention to the quotes!

cmd /s /k ""%ConEmuDir%\..\init.bat" [ADD ARGS HERE]"

Single user portable configuration is possible using the Cmder specific shell config files. Edit the below files to add your own configuration:

Note: Bash and Mintty sessions will also source the$HOME/.bashrc file if it exists after it sources$CMDER_ROOT/config/user_profile.sh.

You can write*.cmd|*.bat,*.ps1, and*.sh scripts and just drop them in the%CMDER_ROOT%\config\profile.d folder to add startup config to Cmder.

To disable Cmder prompt git status globally add the following to~/.gitconfig or locally for a single repo[repo]/.git/config and start a new session.

Note: This configuration is not portable

[cmder]  status = false      # Opt out of Git status for 'ALL' Cmder supported shells.  cmdstatus = false   # Opt out of Git status for 'Cmd.exe' shells.  psstatus = false    # Opt out of Git status for 'Powershell.exe and 'Pwsh.exe' shells.  shstatus = false    # Opt out of Git status for 'bash.exe' shells.

You can define simple aliases forcmd.exe sessions with a command likealias name=command. Cmd.exe aliases support optional parameters through the$1-9 or the$* special characters so the aliasvi=vim.exe $* typed asvi [filename] will open[filename] invim.exe.

Cmd.exe aliases can also be more complex. See:DOSKEY.EXE documentation for additional details on complex aliases/macros forcmd.exe

Aliases defined using thealias.bat command will automatically be saved in the%CMDER_ROOT%\config\user_aliases.cmd file

To make an alias and/or any other profile settings permanent add it to one of the following:

Note: These are loaded in this order by$CMDER_ROOT/vendor/init.bat. Anything stored in%CMDER_ROOT% will be a portable setting and will follow Cmder to another machine.

• %CMDER_ROOT%\config\profile.d\*.cmd and\*.bat
• %CMDER_ROOT%\config\user_aliases.cmd
• %CMDER_ROOT%\config\user_profile.cmd

Bash shells support simple and complex aliases with optional parameters natively so they work a little different. Typingalias name=command will create an alias only for the current running session.

To make an alias and/or any other profile settings permanent add it to one of the following:

Note: These are loaded in this order by$CMDER_ROOT/vendor/git-for-windows/etc/profile.d/cmder.sh. Anything stored in$CMDER_ROOT will be a portable setting and will follow Cmder to another machine.

• $CMDER_ROOT/config/profile.d/*.sh
• $CMDER_ROOT/config/user_profile.sh
• $HOME/.bashrc

If you add bash aliases to$CMDER_ROOT/config/user_profile.sh they will be portable and follow your Cmder folder if you copy it to another machine.$HOME/.bashrc defined aliases are not portable.

PowerShell has native simple alias support, for example[new-alias | set-alias] alias command, so complex aliases with optional parameters are not supported in PowerShell sessions. Typeget-help [new-alias|set-alias] -full for help on PowerShell aliases.

To make an alias and/or any other profile settings permanent add it to one of the following:

Note: These are loaded in this order by$ENV:CMDER_ROOT\vendor\user_profile.ps1. Anything stored in$ENV:CMDER_ROOT will be a portable setting and will follow Cmder to another machine.

• $ENV:CMDER_ROOT\config\profile.d\*.ps1
• $ENV:CMDER_ROOT\config\user_profile.ps1

To start the vendored SSH agent simply callstart-ssh-agent, which is in thevendor/git-for-windows/cmd folder.

If you want to run SSH agent on startup, include the line@call "%GIT_INSTALL_ROOT%/cmd/start-ssh-agent.cmd" in%CMDER_ROOT%/config/user_profile.cmd (usually just uncomment it).

Cmder is by default shipped with a vendored Git installation. On each instance of launching Cmder, an attempt is made to locate any other user provided Git binaries. Upon finding agit.exe binary, Cmder further compares its version against the vendored oneby executing it. The vendoredgit.exe binary isonly used when it is more recent than the user-installed one.

You may use your favorite version of Git by including its path in the%PATH% environment variable. Moreover, theMini edition of Cmder (found on thedownloads page) excludes any vendored Git binaries.

You may run bash (the default shell used on Linux, macOS and GNU/Hurd) externally on Cmder, using the following instructions:

1. Setup a new task by pressingWin +Alt +T.
2. Click the+ button to add a task.
3. Name the new task in the top text box.
4. Provide task parameters, this is optional.
5. Addcmd /c "[path_to_external_env]\bin\bash --login -i" -new_console to theCommands text box.

Recommended Optional Steps:

Copy thevendor/cmder_exinit file to the Cygwin/Babun, MSys2, or Git for Windows SDK environments/etc/profile.d/ folder to use portable settings in the$CMDER_ROOT/config folder.

Note: MinGW could work if the init scripts includeprofile.d but this has not been tested.

The destination file extension depends on the shell you use in that environment. For example:

• bash - Copy to/etc/profile.d/cmder_exinit.sh
• zsh - Copy to/etc/profile.d/cmder_exinit.zsh

Uncomment and edit the line below in the script to use Cmder config even when launched from outside Cmder.

# CMDER_ROOT=${USERPROFILE}/cmder  # This is not required if launched from Cmder.

You can pass custom arguments toinit.bat and usecexec.cmd in youruser_profile.cmd to evaluate thesearguments then execute commands based on a particular flag being detected or not.

init.bat creates two shortcuts for usingcexec.cmd in your profile scripts.

ccall=call C:\Users\user\cmderdev\vendor\bin\cexec.cmd

Example:%ccall% /startnotepad start notepad.exe

cexec=C:\Users\user\cmderdev\vendor\bin\cexec.cmd

Example:%cexec% /startnotepad start notepad.exe

It is useful when you have multiple tasks to executecmder and need it to initializethe session differently depending on the task chosen.

To conditionally startnotepad.exe when you start a specificcmder task:

• Presswin+alt+t

• Click+ to add a new task.

• Add the below to theCommands block:

  cmd.exe /k""%ConEmuDir%\..\init.bat" /startnotepad"

• Add the below to your%cmder_root%\config\user_profile.cmd

  %ccall%"/startNotepad""start""notepad.exe"`

To see detailed usage ofcexec, typecexec /? in Cmder.

Cmder by default comes with a vendored ConEmu installation as the underlying terminal emulator, as statedhere.

However, Cmder can in fact run in a variety of other terminal emulators, and even integrated IDEs. Assuming you have the latest version of Cmder, follow the following instructions to get Cmder working with your own terminal emulator.

For instructions on how to integrate Cmder with your IDE, please read ourWiki section.

The process of upgrading Cmder depends on the version/build you are currently running.

If you have a[cmder_root]/config/user[-|_]conemu.xml, you are running a newer version of Cmder, follow the below process:

1. Exit all Cmder sessions and relaunch[cmder_root]/cmder.exe, this backs up your existing[cmder_root]/vendor/conemu-maximus5/conemu.xml to[cmder_root]/config/user[-|_]conemu.xml.

   • The[cmder_root]/config/user[-|_]conemu.xml contains any custom settings you have made using the 'Setup Tasks' settings dialog.

2. Exit all Cmder sessions and backup any files you have manually edited under[cmder_root]/vendor.

   • Editing files under[cmder_root]/vendor is not recommended since you will need to re-apply these changes after any upgrade. All user customizations should go in[cmder_root]/config folder.

3. Delete the[cmder_root]/vendor folder.

4. Extract the newcmder.zip orcmder_mini.zip into[cmder_root]/ overwriting all files when prompted.

If you do not have a[cmder_root]/config/user[-|_]conemu.xml, you are running an older version of cmder, follow the below process:

1. Exit all Cmder sessions and backup[cmder_root]/vendor/conemu-maximus5/conemu.xml to[cmder_root]/config/user[-|_]conemu.xml.

2. Backup any files you have manually edited under[cmder_root]/vendor.

   • Editing files under[cmder_root]/vendor is not recommended since you will need to re-apply these changes after any upgrade. All user customizations should go in[cmder_root]/config folder.

3. Delete the[cmder_root]/vendor folder.

4. Extract the newcmder.zip orcmder_mini.zip into[cmder_root]/ overwriting all files when prompted.

You can download builds of the current development branch by going to AppVeyor via the following link:

The latest download builds by GitHub Actions can be downloaded from the link below:

All software included is bundled with own license

The MIT License (MIT)

Copyright (c) 2016 Samuel Vasko

Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included inall copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS INTHE SOFTWARE.