Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/apache/commons-cli

Apache Commons CLI
https://github.com/apache/commons-cli

commons

Last synced: about 22 hours ago
JSON representation

Apache Commons CLI

Host: GitHub
URL: https://github.com/apache/commons-cli
Owner: apache
License: apache-2.0
Created: 2009-05-28T08:00:15.000Z (over 15 years ago)
Default Branch: master
Last Pushed: 2024-12-13T10:10:42.000Z (8 days ago)
Last Synced: 2024-12-13T17:01:32.427Z (8 days ago)
Topics: commons
Language: Java
Homepage: http://commons.apache.org/cli/
Size: 3.48 MB
Stars: 354
Watchers: 43
Forks: 194
Open Issues: 3
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome-cli-frameworks - Apache Commons CLI

README

        

Apache Commons CLI

===================

[![Java CI](https://github.com/apache/commons-cli/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-cli/actions/workflows/maven.yml)

[![Maven Central](https://img.shields.io/maven-central/v/commons-cli/commons-cli?label=Maven%20Central)](https://search.maven.org/artifact/commons-cli/commons-cli)

[![Javadocs](https://javadoc.io/badge/commons-cli/commons-cli/1.9.0.svg)](https://javadoc.io/doc/commons-cli/commons-cli/1.9.0)

[![CodeQL](https://github.com/apache/commons-cli/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-cli/actions/workflows/codeql-analysis.yml)

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-cli/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-cli)

Apache Commons CLI provides a simple API for presenting, processing, and validating a Command Line Interface.

Documentation

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

More information can be found on the [Apache Commons CLI homepage](https://commons.apache.org/proper/commons-cli).

The [Javadoc](https://commons.apache.org/proper/commons-cli/apidocs) can be browsed.

Questions related to the usage of Apache Commons CLI should be posted to the [user mailing list](https://commons.apache.org/mail-lists.html).

Getting the latest release

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

You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-cli/download_cli.cgi).

Alternatively, you can pull it from the central Maven repositories:

```xml

  commons-cli

  commons-cli

  1.9.0

```

Building

--------

Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).

The required Java version is found in the `pom.xml` as the `maven.compiler.source` property.

From a command shell, run `mvn` without arguments to invoke the default Maven goal to run all tests and checks.

Contributing

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

We accept Pull Requests via GitHub. The [developer mailing list](https://commons.apache.org/mail-lists.html) is the main channel of communication for contributors.

There are some guidelines which will make applying PRs easier for us:

+ No tabs! Please use spaces for indentation.

+ Respect the existing code style for each file.

+ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.

+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.

+ Before you pushing a PR, run `mvn` (by itself), this runs the default goal, which contains all build checks.

+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false`

If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).

You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).

License

-------

This code is licensed under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0).

See the `NOTICE.txt` file for required notices and attributions.

Donating

--------

You like Apache Commons CLI? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support development.

Additional Resources

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

+ [Apache Commons Homepage](https://commons.apache.org/)

+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/CLI)

+ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)

+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)

Apache Commons Components

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

Please see the [list of components](https://commons.apache.org/components.html)