Cross-platform toolkit for easy development of TUI applications.
C# Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
Binding Moved to .NET 4.5, with prefer of modern reflection API (to be compat… Sep 11, 2016
ConsoleFramework Removed workaround for Windows 10 Technical Preview (seems fixed in W… Sep 11, 2016
Examples Moved to .NET 4.5, with prefer of modern reflection API (to be compat… Sep 11, 2016
Xaml Moved to .NET 4.5, with prefer of modern reflection API (to be compat… Sep 11, 2016
.hgignore + Added prototype app for web using JSIL. Apr 7, 2014
.travis.yml Added '.travis.yml'. Sep 11, 2016
ConsoleFramework.vsmdi Initial commit. Dec 8, 2011
Local.testsettings Initial commit. Dec 8, 2011
TraceAndTestImpact.testsettings * Fixed nant build. Added libtermkey-0.18 for linux x86. Feb 28, 2016

Console Framework

Console framework is cross-platform toolkit that allows to develop TUI applications using C# and based on WPF-like concepts.


  • Declarative markup (custom lightweight XAML implementation)
  • Data binding (integrated with XAML markup)
  • Retained mode rendering system
  • WPF-compatible simple and flexible layout system
  • A lot of controls available (including Grid, ScrollViewer, ListBox, ComboBox)
  • Routed events system (compatible with WPF)
  • Windows, Mac OS X and any Linux (32-bit or 64-bit) support


Copyright 2011-2014 I. Kostromin

License: MIT/X11

Build from source

To build a library with examples you can use NAnt:

nant build

It works in all platforms.

Native dependencies

In Windows there are no native dependencies. But in Linux and Mac OS X environments you should prepare some native dependencies to be able to execute examples. Dependencies are:

  • libtermkey
  • libc
  • ncursesw

To build libtermkey go to its source code directory and simply run


After that you can copy binaries from ./libs into directory with examples. Or you can use binaries of libtermkey from zip in /native directory.

Libc and ncursesw are distributed in binaries in vast majority of Linux distros and OS X, so all you need is locate actual binaries and copy them in the output directory if the target machine does not have them, for example, if you are Mac OS X user, you will need to install libtermkey.

brew install --universal libtermkey

Console Framework expects that libraries will be available strictly by these names on Linux. If your system already has symlinks and, you can skip this step.

Running examples

mono Example_HelloWorld.exe

Press Ctrl+D to exit application.

Terminal emulators in Mac OS X

Standard terminal emulator is not very good for console applications deals with mouse. My recommendation is to use ITerm2. ITerm2 provides a good emulation with mouse support. If you want to see how console framework renders in various Mac emulators, visit