https://github.com/umermansoor/microcli

Java boilerplate Command Line Interface using ANTRL3. Complete examples with sample commands.
https://github.com/umermansoor/microcli

Last synced: 25 days ago
JSON representation

Java boilerplate Command Line Interface using ANTRL3. Complete examples with sample commands.

• Host: GitHub
• URL: https://github.com/umermansoor/microcli
• Owner: umermansoor
• Created: 2012-07-13T02:44:58.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-07-13T06:18:10.000Z (over 12 years ago)
• Last Synced: 2024-04-15T04:22:50.274Z (9 months ago)
• Language: Java
• Homepage:
• Size: 113 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README

Awesome Lists containing this project

README

        
# Micro CLI v 0.1

# Last updated: July 10, 2012 @ 10pm MST.

# Released under Apache Software License v2.0

# Libraries/Dependencies used:

# ============================

# Important ones are described below:

# JLine: for handling console input. Handles command history & tab completion 

# (Apache) Commons CLI: for parsing & handling command line options passed to the program (e.g. microcli.jar --v)  

# ANTLRv3: for interpreting commands and arguments  

# Build Instructions:

# ===================

# Micro CLI uses ANTLR to parse commands. ANTLR 

# To (re)Generate Grammar

# You will need to install ANTLR3 and add the JAR to CLASSPATH

# e.g.

export CLASSPATH=/Users/umermansoor/Documents/java-code/antlr3/antlr-3.3-complete.jar:$CLASSPATH

# After creating the Grammar (.g) file, run the following command to generate Lexer, Parser, etc. Source for Java:

java org.antlr.Tool CliAntlr.g

# The Micro CLI project is uses Maven to build. Change to the main project directory (one containing pom.xml) and run the following command:

mvn clean package

# This will generate the jar file. I like one jar file will all the dependencies bundled into it. To launch Micro CLI, run the following command:

java -jar ./target/microcli-jar-with-dependencies.jar

# Note: Feel free to change maven packaging and assembly type as you like.