2 :ID: bb4f96cd-458c-495b-a605-313b2e3e28d2
4 #+TITLE: CLI Helper - library to help implementing commandline interfaces
7 - This program is free software: released under Creative Commons Zero
12 - Homepage: https://svjatoslav.eu
13 - Email: mailto://svjatoslav@svjatoslav.eu
15 - [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
18 - [[https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
20 - [[https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=summary][Browse Git repository online]]
22 - Clone Git repository using command:
23 : git clone https://www2.svjatoslav.eu/git/cli-helper.git
25 - See [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/][JavaDoc]]
29 :ID: fef7ebc3-0f00-4b82-a926-c0cfdf709762
31 - See also: [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][CLI Helper JavaDoc]].
33 This is library intended to facilitate creation of commandline
34 applications in Java programming language. Library is packaged as an
35 artifact to Maven repository. This makes it simple to add library as
36 dependency to your project.
38 Library provides following general functionalities:
39 - [[id:4fca35e4-fdf1-4675-a36f-6206d6fb72cb][Asking for user input]]
40 - [[id:46115263-ed3d-4acc-9ec5-523d7acf87b8][Commandline arguments processing]]
44 :ID: 4fca35e4-fdf1-4675-a36f-6206d6fb72cb
47 - askBoolean() :: Asks the user to enter a boolean value (yes/no).
48 - askLong() :: Asks the user to enter an integer.
49 - askString() :: Asks the user to enter a string.
52 Instructions to embed svjatoslav-commons library in your project:
54 Maven pom.xml file snippet:
60 <groupId>eu.svjatoslav</groupId>
61 <artifactId>cli-helper</artifactId>
62 <version>1.1</version>
71 <id>svjatoslav.eu</id>
72 <name>Svjatoslav repository</name>
73 <url>http://www3.svjatoslav.eu/maven/</url>
80 List of improvement suggestions:
82 - Add more concrete examples of how to use the library in JavaDoc
83 comments. This will help developers quickly get started and learn
86 - Provide more comprehensive unit tests for CliHelper,
87 ParameterParser, Options and subclasses. This will ensure robustness
90 - Add JavaDoc comments to all classes and methods where
91 applicable. This will provide better visibility into the library's
92 functionality for developers.
94 - Add more option types like date/time, regular expression etc.
96 - Document best practices for using the library in a larger project.
98 - Implement support for more complex CLI applications like option
99 dependencies and conflicts resolution.