[ Home | Main Table Of Contents | Table Of Contents | Keyword Index ]

cmdr-changes(n) 1.1 doc "Cmdr, a framework for command line parsing and dispatch"


cmdr-changes - Cmdr - Log of Changes

Table Of Contents


Welcome to the Cmdr project, written by Andreas Kupries.

For availability please read Cmdr - How To Get The Sources.

This document provides an overview of the changes cmdr underwent from version to version.


Changes for version 1.1

  1. Fixed broken requirement references in the meta data of packages cmdr::help::json and cmdr::help::sql.

  2. Fixed initialization issues in the help generator.

  3. Fixed generated help, added the application name to the output when in a cmdr shell.

  4. Fixed the generation of help format by-categorized, when encountering sections with sub-sections and no commands of their own.

  5. Fixed bad method scoping in method extend of officers.

  6. Extended officer method extend to return the created private, for immediate post-creation re-configuration.

  7. Extended system with new help format tcl, and associated package cmdr::help::tcl. Similar to format json the help is printed as a nested data structure, just using Tcl syntax.

  8. Extended officers and privates with method find for path lookup of sub-ordinates.

Changes for version 1

This is the first release of cmdr. The changes therefore describe the initial features of the system.

In detail:

  1. cmdr requires Tcl 8.5 or higher. Tcl 8.4 or less is not supported.

  2. The framework provides a DSL for the declaration of a hierarchy of commands and their parameters (named options, positional arguments, hidden state), with help texts, type information, and various callbacks (command actions, parameter definition, parameter completion, type validation, command completion, etc.)

  3. At runtime the framework provides parsing and processing of command lines per specifications written in that DSL, determining the command to run, and the mapping from command line words to its parameters.

  4. The framework also provides shells for the interactive entry of commands and parameters, with command line completion.

  5. Last, but not least is the automatic generation of command line help for commands and parameters, based on the information provided in a specification.

Related Documents

  1. Cmdr - Introduction to the project

  2. Cmdr - License

  3. Cmdr - Log of Changes

  4. Cmdr - How To Get The Sources

  5. Cmdr - The Installer's Guide

  6. Cmdr - The Developer's Guide

Bugs, Ideas, Feedback

Both the package(s) and this documentation will undoubtedly contain bugs and other problems. Please report such at Cmdr Tickets.

Please also report any ideas you may have for enhancements of either package(s) and/or documentation.


arguments, command hierarchy, command line completion, command line handling, command tree, editing command line, help for command line, hierarchy of commands, interactive command shell, optional arguments, options, parameters, processing command line, tree of commands