CLI Power Tools

Updated 07/10/2003

CLI Power Tools is a command-line interface (CLI) development tool for embedded software developers that dramatically decreases the resources needed to develop a high-quality CLI. Unlike some other packages, it is designed for team development and can produce a truly Cisco-compliant CLI.

If you need to develop a CLI for a network-based hardware or software product, CLI Power Tools could cut 3 to 6 months off the development time. Here's how it works:

You describe individual commands in a simple Command Description Language (CDL). The CDL file describes the syntax of the command, including keywords, parameters, optional parameters, repeating parameters, parameter ranges, context-sensitive help messages, modes, and privileges. Each command also has a piece of code attached to actually execute its action. (Currently the code can be C or C++, although other languages are being implemented.) A CDL compiler and linker check for errors and generate run-time data structures which are used by a run-time parser to recognize commands, provide context-sensitive help, provide command completion, and perform range and error checks.

Because so much of the work is performed by the CLI infrastructure, each command can be implemented simply; the developer does not need to worry about being called in the wrong mode or with invalid parameters. Because command descriptions can be distributed among as many separate CDL source files as desired, the infrastructure is revision-control friendly and allows multiple developers to work on the CLI at once without stepping on one-another's toes.

The generated program has the look and feel you'd expect from a mature CLI, including all of the features found in the CLI for Cisco routers:

Command history and command-line editing.
Context-specific help - Press the question-mark key at any time to see a list of legal next parameters, with descriptions.)
Keyword completion - Type a partial keyword and press the <tab> key. The rest of the keyword will be entered automatically.
Modes - Each command can belong to one or more modes. The command is not recognized (visible) in any other mode. Modes can be designed with sub-modes which inherit all of the commands of their parent modes.
Privilege - Each command can be assigned a set of privilege attributes. A command may not be executed if the user does not have sufficient privilege
Keyword abbreviations - Any keyword can be recognized just be typing an unambiguous prefix (e.g., "sh" for "show").
Order-independent parameters - A command's syntax can be specified such that a set of parameters can be specified in any order. (e.g., "run far fast" could also be typed "run fast far"). The decision as to which parameters must be specified in a specific order and which parameters are order-independent is made by the developer on a per-command basis.
Error checking - Before executing a command, the CLI checks that the current mode is still valid (e.g. the current interface card has not been disabled), the user has sufficient privilege, and each parameter is within the legal range, etc.. When possible, the user is alerted to the error by displaying a caret under the offending word along with an error message.

Features of the CLI Power Tools tool kit:

Simple language for describing CLI commands. See the Command Description Language (CDL) Overview (PDF format).
Revision-control friendly - Each command can be in a separate source file, or related commands can be grouped into a single source file.
Generated CLI is fast and memory-efficient - suitable for embedded systems.
Can be ported to many different programming languages. Please ask.

For more information:

Visit the CLI Power Tools home page at http://www.halpernwightsoftware.com/CLI or
Call Pablo Halpern at (603) 654-6474 or
Email clipowertools@halpernwightsoftware.com