Overview

Clink combines the native Windows shell cmd.exe with the powerful command line editing features of the GNU Readline library, which provides rich completion, history, and line-editing capabilities. Readline is best known for its use in the well-known Unix shell Bash, the standard shell for Mac OS X and many Linux distributions.

Download

Downloads are available from the releases page.

There are no production releases yet; currently only pre-release builds are available, for testing purposes.

See the issues page for known issues or to file new issues.

Features

• The same line editing as Bash (from the GNU Readline library version 8.0).
• History persistence between sessions.
• Context sensitive completion;
  • Executables (and aliases).
  • Directory commands.
  • Environment variables
  • Thirdparty tools; Git, Mercurial, SVN, Go, and P4.
• New keyboard shortcuts;
  • Paste from clipboard (Ctrl+V).
  • Incremental history search (Ctrl+R/Ctrl+S).
  • Powerful completion (Tab).
  • Undo (Ctrl+Z).
  • Automatic cd .. (Ctrl+PgUp).
  • Environment variable expansion (Ctrl+Alt+E).
  • Doskey alias expansion (Ctrl+Alt+F).
  • (press Alt+H) for many more...)
• Scriptable completion with Lua.
• Coloured and scriptable prompt.
• Auto-answering of the "Terminate batch job?" prompt.

Usage

There are a variety of ways to start Clink;

1. If you installed the auto-run, just start cmd.exe. Run clink autorun --help for more info.
2. To manually start, run the Clink shortcut from the Start menu (or the clink.bat located in the install directory).
3. To establish Clink to an existing cmd.exe process, use <install_dir>\clink.exe inject

Extending Clink

Clink can be extended through its Lua API which allows easy creation of context sensitive match generators, prompt filtering, and more. More details can be found in Clink's documentation here.

Building Clink

Clink uses Premake to generate Visual Studio solutions or makefiles for MinGW. Note that Premake >= 5.0-alpha12 is required.

1. Cd to your clone of Clink.
2. Run premake5.exe <toolchain> (where <toolchain> is one of Premake's actions - see premake5.exe --help)
3. Build scripts will be generated in .build\<toolchain>. For example .build\vs2013\clink.sln.
4. Call your toolchain of choice (VS, mingw32-make.exe, msbuild.exe, etc). GNU makefiles (Premake's gmake target) have a help target for more info.

Building Documentation

1. Run npm install marked to install the marked markdown library.
2. Run premake5.exe docs.

License

Clink is distributed under the terms of the GNU General Public License v3.0.