Documentation/CLI Support in CTK

This page is a working draft and does not contain final information.

Command Line Interface (CLI) support in CTK will primarly focus on providing an API for working with existing CLI modules. Providing utiltities and tools for creating CLI modules from scratch is a desired addition but there are no concrete plans for this yet.

Experimental Code

Some experimental code can be found here:

https://github.com/commontk/CTK/tree/cli-module-support

Enable the following CMake options to be able to play with the code:

• BUILD_TESTING (for creating CLI test modules)
• CTK_APP_ctkCommandLineModuleExplorer (small program allowing you to test-drive CLI modules using the CTK CLI module API)
• CTK_BUILD_QTDESIGNER_PLUGINS (needed by the ctkCLIPluginExplorer to create a Qt GUI from the generated .ui files at runtime)
• CTK_LIB_CommandLineModules (the CTK library providing the CLI module API)
• CTK_LIB_Widgets (used by the ctkCLIPluginExplorer to create a Qt GUI for the CLI module from the .ui file)

API Design

...

Customizability

...

Boston Hackfest Work Items

...