Clad: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 9: Line 9:
* command-line and YAML-based persistent configuration
* command-line and YAML-based persistent configuration
* hierarchical in-line help
* hierarchical in-line help
* logging and error message handling support
* consistent logging and error message handling support
* version and release date mechanism
* built-in version and release date support
* standard release tools
* standard release tools


Line 28: Line 28:
:<br>https://github.com/NovaOrdis/clad<br><br>
:<br>https://github.com/NovaOrdis/clad<br><br>
</blockquote>
</blockquote>
=TODO=
doc/cliff.docx TODO section.
=Features=
==Version and Release Date==
The framework supports the "version" command by default. The "version" command pulls version and release date from the underlying application and displays it in a standard format:
<pre>
version 1.0
release date 01/26/16
</pre>


=User Manual=
=User Manual=


doc/cliff.docx
<blockquote style="background-color: #f9f9f9; border: solid thin lightgrey;">
:[[clad User Manual]]
</blockquote>


=Development=
=Development=


==New Release==
<blockquote style="background-color: #f9f9f9; border: solid thin lightgrey;">
 
:[[clad Development]]
This will install a new "development" release (same release number) in the Maven repository:
</blockquote>
<pre>
cdclad
mvn clean install
</pre>
 
==Indvidual Unit Test==
 
<pre>
mvn -Dmaven.surefire.debug="-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5012" -Dtest=StringOptionTest clean test
</pre>

Latest revision as of 17:40, 16 November 2016

Internal

Overview

Command-Line Application Development (clad) is a collection of Java classes providing functionality that can be used to build command line tools. It includes support for:

  • command-oriented CLI
  • command-line and YAML-based persistent configuration
  • hierarchical in-line help
  • consistent logging and error message handling support
  • built-in version and release date support
  • standard release tools

The project's artifact is a java library other dependent project can get from a Maven repository:

<dependency>
    <groupId>io.novaordis.clad</groupId>
    <artifactId>novaordis-clad</artifactId>
    <version>1</version>
</dependency>

GitHub


https://github.com/NovaOrdis/clad

User Manual

clad User Manual

Development

clad Development