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 * Library contents
  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 library is a collection of command-line interface (CLI) helper
  34 functions that simplifies the process of building and maintaining CLI
  35 applications. The library provides several different functionalities,
  36 such as:
  37
  38 - [[id:4fca35e4-fdf1-4675-a36f-6206d6fb72cb][Asking for user input]]
  39 - [[id:46115263-ed3d-4acc-9ec5-523d7acf87b8][Commandline interface arguments processing]]
  40
  41 ** Ask for user input
  42 :PROPERTIES:
  43 :ID:       4fca35e4-fdf1-4675-a36f-6206d6fb72cb
  44 :END:
  45
  46 - askBoolean() :: Asks the user to enter a boolean value (yes/no).
  47 - askLong() :: Asks the user to enter an integer.
  48 - askString() :: Asks the user to enter a string.
  49
  50 * Getting the library
  51 Instructions to embed svjatoslav-commons library in your project:
  52
  53 Maven pom.xml file snippet:
  54
  55 #+BEGIN_SRC xml
  56 <dependencies>
  57     ...
  58     <dependency>
  59         <groupId>eu.svjatoslav</groupId>
  60         <artifactId>cli-helper</artifactId>
  61         <version>1.0</version>
  62     </dependency>
  63     ...
  64 </dependencies>
  65
  66
  67 <repositories>
  68     ...
  69     <repository>
  70         <id>svjatoslav.eu</id>
  71         <name>Svjatoslav repository</name>
  72         <url>http://www3.svjatoslav.eu/maven/</url>
  73     </repository>
  74     ...
  75 </repositories>
  76 #+END_SRC