JSimpleShell

If you dont want to spent much time to design and implement your own user interface you've come to the right place! This project is a lightweight and simple-to-use library, with wich one you can create your own shell (as a command line interface) in java! It based on cliche but use jline2 to improve the shell functionality.

Feature-List

• Implement a command via annotation
• Show help-text for each command
• Colored output
• Persistable command history
• Searching through the command history
• Arrow-Key navigation
• Sub-Shells
• Scriptable
  • execute command line by line
  • define and use variables
  • use loops
• Clear screen function
• Platform independent
• Maven integration (artifacts are stored in maven central)
• Masking input (helpful for password inputs)
• Param type dependent autocompletion (Commands and File-Pathes are available by default)
• All messages can be resolved (useful for l18n)
• Recording macros
• Runtime user input validation (own mechanism or JSR303-Validation are possible)

For possible future changes see here

How it works

The following code is a simple example. This code starts a shell that contains two custom commands.

import java.io.IOException;

import de.raysha.lib.jsimpleshell.Shell;
import de.raysha.lib.jsimpleshell.builder.ShellBuilder;
import de.raysha.lib.jsimpleshell.annotation.Command;
import de.raysha.lib.jsimpleshell.annotation.Param;

public class Example {

	public static void main(String[] args) throws IOException {
		Shell shell = ShellBuilder.shell("MyShell")
				.behavior()
					.addHandler(new Example())
				.build();

		shell.commandLoop();
	}

	@Command(abbrev="add")
	public Long addition(Integer...integers){
		Long result = 0L;
		for(Integer i : integers){
			result += i;
		}

		return result;
	}

	@Command(name="division", abbrev="div")
	public Double div(
			@Param("dividend") Double a,
			@Param("divisor") Double b){

		return a / b;
	}
}

If you run this little application you will see the following:

MyShell> ?list
abbrev    name       parameter
exit      exit       ()
add       addition   (p1...)
div       division   (dividend, divisor)
MyShell> div 10 5
2.0
MyShell> exit

Look here for an addition example: here

Demo version

Checkout the release area to download the JSimpleShell-Demo. For each release exists a runnable-jar-file, a zip-file and a tar.gz-file. Choose which you want and start the Demo :)

License

JSimpleShell is distributed under the BSD License (3-Clause).

Maven Usage

If you want to add JSimpleShell to your maven project, you can add the following dependency in your pom.xml:

<dependency>
	<groupId>de.raysha.lib</groupId>
	<artifactId>jsimpleshell</artifactId>
	<version>4.0</version>
</dependency>

Version-Policy

When I will change which part of the version number? The version has three parts:

1.2.3
| | |
| | +- Patch
| +--- Minor
+----- Major

Version	When it will be changed
Major	If one or more additional features have been added, which breaks the existing interfaces! If you want to upgrade to this version you(might) have to migrate your code.
Minor	If one or more additional features have been added, which breaks not the existing interfaces. You can upgrade to this version without any risk.
Patch	If any bug was fixed. You can upgrade to this version without any risk.

Building

Requirements

• Maven 3+
• Java 6+

Check out and build:

git clone git://github.com/rainu/jsimpleshell
cd jsimpleshell
mvn clean install

Eclipse integration

If you want to import the project into your eclipse, you must execute the following maven command:

mvn eclipse:eclipse

Now you can import "An existing Project into your workspace".