:PROPERTIES:
:ID:       bb4f96cd-458c-495b-a605-313b2e3e28d2
:END:
#+TITLE: CLI Helper - library to help implementing commandline interfaces

* General
- This program is free software: released under Creative Commons Zero
  (CC0) license

- Program author:
  - Svjatoslav Agejenko
  - Homepage: https://svjatoslav.eu
  - Email: mailto://svjatoslav@svjatoslav.eu

- [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]

** Source code
- [[https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]

- [[https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=summary][Browse Git repository online]]

- Clone Git repository using command:
  : git clone https://www2.svjatoslav.eu/git/cli-helper.git

- See [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/][JavaDoc]]

* Library contents
:PROPERTIES:
:ID:       fef7ebc3-0f00-4b82-a926-c0cfdf709762
:END:
- See also: [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][CLI Helper JavaDoc]].

This library is a collection of command-line interface (CLI) helper
functions that simplifies the process of building and maintaining CLI
applications. The library provides several different functionalities,
such as:

- [[id:4fca35e4-fdf1-4675-a36f-6206d6fb72cb][Asking for user input]]
- [[id:46115263-ed3d-4acc-9ec5-523d7acf87b8][Commandline interface arguments processing]]

** Ask for user input
:PROPERTIES:
:ID:       4fca35e4-fdf1-4675-a36f-6206d6fb72cb
:END:

- askBoolean() :: Asks the user to enter a boolean value (yes/no).
- askLong() :: Asks the user to enter an integer.
- askString() :: Asks the user to enter a string.

* Getting the library
Instructions to embed svjatoslav-commons library in your project:

Maven pom.xml file snippet:

#+BEGIN_SRC xml
<dependencies>
    ...
    <dependency>
        <groupId>eu.svjatoslav</groupId>
        <artifactId>cli-helper</artifactId>
        <version>1.0</version>
    </dependency>
    ...
</dependencies>


<repositories>
    ...
    <repository>
        <id>svjatoslav.eu</id>
        <name>Svjatoslav repository</name>
        <url>http://www3.svjatoslav.eu/maven/</url>
    </repository>
    ...
</repositories>
#+END_SRC