https://github.com/kohsuke/args4j

args4j
https://github.com/kohsuke/args4j

Last synced: 6 days ago
JSON representation

args4j

• Host: GitHub
• URL: https://github.com/kohsuke/args4j
• Owner: kohsuke
• License: mit
• Created: 2011-06-17T16:17:14.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2024-03-06T16:54:02.000Z (10 months ago)
• Last Synced: 2024-12-08T05:03:06.522Z (14 days ago)
• Language: Java
• Homepage: http://args4j.kohsuke.org/
• Size: 6.86 MB
• Stars: 789
• Watchers: 33
• Forks: 188
• Open Issues: 81
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-cli-frameworks - args4j

README

        
args4j

======

args4j is a small Java class library that makes it easy to parse command line options/arguments in your CUI

application. See more info at https://args4j.kohsuke.org/

Why should I use it?

--------------------

See [the quick intro](https://web.archive.org/web/20120605024439/http://weblogs.java.net/blog/kohsuke/archive/2005/05/parsing_command.html)

- It makes command line parsing very easy by using annotations

- Generate usage text very easily

- Generate HTML/XML documentation listing all options

- Full localization support

- Designed to parse javac like options, as opposed to GNU-style (where ls -lR is considered to have two options l and

  R).

- Licensed under [the MIT license](https://opensource.org/license/mit/).

How can I use it?

-----------------

1. Check [the sample](https://github.com/kohsuke/args4j/blob/master/args4j/examples/SampleMain.java). This is how your

   code will look like.

2. [Download](https://search.maven.org/search?q=g:args4j%20AND%20a:args4j) the distribution or include the library from

   the Maven Repository.

3. Write your code.

More Resources

--------------

1. [A small tutorial](https://args4j.kohsuke.org/sample.html) for the use of the Starter and Args4J

2. [javadoc](https://args4j.kohsuke.org/args4j/apidocs/)

3. [How to generate a documentation for your CLI](https://args4j.kohsuke.org/apt.html)

4. [Extend args4j to handle other Java types](https://args4j.kohsuke.org/implementOptionhandler.html)

5. [Kohsuke's Blog: Parsing command line options in JDK 5.0 style](https://web.archive.org/web/20120605024439/http://weblogs.java.net/blog/kohsuke/archive/2005/05/parsing_command.html)

6. [A comparison between Commons CLI and Args4j](https://hikage.developpez.com/java/articles/api/cli-vs-args4j/) in

   French