6ed2f6ece46a1dea362927c5a427005a8e47cb04
[cli-helper.git] / doc / index.org
1 :PROPERTIES:
2 :ID:       bb4f96cd-458c-495b-a605-313b2e3e28d2
3 :END:
4 #+TITLE: CLI Helper - library to help implementing commandline interfaces
5
6 * General
7 - This program is free software: released under Creative Commons Zero
8   (CC0) license
9
10 - Program author:
11   - Svjatoslav Agejenko
12   - Homepage: https://svjatoslav.eu
13   - Email: mailto://svjatoslav@svjatoslav.eu
14
15 - [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
16
17 ** Source code
18 - [[https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
19
20 - [[https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=summary][Browse Git repository online]]
21
22 - Clone Git repository using command:
23   : git clone https://www2.svjatoslav.eu/git/cli-helper.git
24
25 - See [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/][JavaDoc]]
26
27 * Overview
28 :PROPERTIES:
29 :ID:       fef7ebc3-0f00-4b82-a926-c0cfdf709762
30 :END:
31 - See also: [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][CLI Helper JavaDoc]].
32
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.
37
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]]
41
42 ** Ask for user input
43 :PROPERTIES:
44 :ID:       4fca35e4-fdf1-4675-a36f-6206d6fb72cb
45 :END:
46
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.
50
51 * Getting the library
52 Instructions to embed svjatoslav-commons library in your project:
53
54 Maven pom.xml file snippet:
55
56 #+BEGIN_SRC xml
57 <dependencies>
58     ...
59     <dependency>
60         <groupId>eu.svjatoslav</groupId>
61         <artifactId>cli-helper</artifactId>
62         <version>1.0</version>
63     </dependency>
64     ...
65 </dependencies>
66
67
68 <repositories>
69     ...
70     <repository>
71         <id>svjatoslav.eu</id>
72         <name>Svjatoslav repository</name>
73         <url>http://www3.svjatoslav.eu/maven/</url>
74     </repository>
75     ...
76 </repositories>
77 #+END_SRC
78 * TODO:
79
80 List of improvement suggestions:
81
82 - Add more concrete examples of how to use the library in JavaDoc
83   comments. This will help developers quickly get started and learn
84   the API.
85
86 - Provide more comprehensive unit tests for CliHelper,
87   ParameterParser, Options and subclasses. This will ensure robustness
88   and stability.
89
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.
93
94 - Add more option types like date/time, regular expression etc.
95
96 - Document best practices for using the library in a larger project.
97
98 - Implement support for more complex CLI applications like option
99   dependencies and conflicts resolution.