Project icon

com.io7m.quarrel

Build status Maven Central Codecov

The quarrel package provides a lightweight, strongly-typed command-line parser.

Contents

Features

  • Strongly-typed access to command-line arguments, for program correctness.
  • Simple and regular command-line parsing for easily understood command-line interfaces.
  • Automatic generation of "help" and "version" commands for command-line interfaces.
  • Detailed, structured, and localized user-facing error messages for clear explanations as to how to use the command-line interfaces correctly.
  • A small, easily auditable codebase with no use of reflection or annotations.
  • An extensive automated test suite with high coverage.
  • Supplies a restricted form of @ syntax, for storing command-line arguments in files.
  • Fully documented, with usage tutorial.
  • OSGi-ready
  • JPMS-ready
  • ISC license.

Releases

The most recently published version of the software is 1.6.1.

Source code and binaries are available from the repository.

Documentation

Documentation for the 1.6.1 release is available for reading online.

Documentation for current and older releases is archived in the repository.

User Documentation

Maven

The following is a complete list of the project's modules expressed as Maven dependencies: 

<dependency>
  <groupId>com.io7m.quarrel</groupId>
  <artifactId>com.io7m.quarrel</artifactId>
  <version>1.6.1</version>
</dependency>

<dependency>
  <groupId>com.io7m.quarrel</groupId>
  <artifactId>com.io7m.quarrel.core</artifactId>
  <version>1.6.1</version>
</dependency>

<dependency>
  <groupId>com.io7m.quarrel</groupId>
  <artifactId>com.io7m.quarrel.documentation</artifactId>
  <version>1.6.1</version>
</dependency>

<dependency>
  <groupId>com.io7m.quarrel</groupId>
  <artifactId>com.io7m.quarrel.example</artifactId>
  <version>1.6.1</version>
</dependency>

<dependency>
  <groupId>com.io7m.quarrel</groupId>
  <artifactId>com.io7m.quarrel.ext.logback</artifactId>
  <version>1.6.1</version>
</dependency>

<dependency>
  <groupId>com.io7m.quarrel</groupId>
  <artifactId>com.io7m.quarrel.ext.xstructural</artifactId>
  <version>1.6.1</version>
</dependency>

<dependency>
  <groupId>com.io7m.quarrel</groupId>
  <artifactId>com.io7m.quarrel.tests</artifactId>
  <version>1.6.1</version>
</dependency>

Each release of the project is made available on Maven Central within ten minutes of the release announcement.

Changes

Subscribe to the releases atom feed.

2024-05-10 Release: com.io7m.quarrel 1.6.1
2024-03-20 Change: Update nl.jqno.equalsverifier:equalsverifier:3.14.2 → 3.15.8
2024-03-20 Change: Update org.slf4j:slf4j-api:2.0.7 → 2.0.12
2024-03-20 Change: Update ch.qos.logback:logback-classic:1.4.7 → 1.5.3
2024-03-20 Change: Update commons-io:commons-io:2.13.0 → 2.15.1
2024-03-20 Change: Update com.io7m.jxtrand:com.io7m.jxtrand.api:1.1.0 → 2.0.0
2024-03-20 Change: Update com.io7m.jxtrand:com.io7m.jxtrand.vanilla:1.1.0 → 2.0.0
2024-03-20 Change: Update net.jqwik:jqwik-api:1.7.3 → 1.8.4
2024-03-20 Change: Update net.jqwik:jqwik-engine:1.7.3 → 1.8.4
2024-03-20 Change: Update org.junit.jupiter:junit-jupiter-api:5.9.3 → 5.10.2
2024-03-20 Change: Update org.junit.jupiter:junit-jupiter-engine:5.9.3 → 5.10.2
2024-05-07 Change: Update ch.qos.logback:logback-classic:1.5.3 → 1.5.6.
2024-05-07 Change: Update commons-io:commons-io:2.15.1 → 2.16.1.
2024-05-07 Change: Update nl.jqno.equalsverifier:equalsverifier:3.15.8 → 3.16.1.
2024-05-07 Change: Update org.slf4j:slf4j-api:2.0.12 → 2.0.13.
2024-05-09 Change: Update com.io7m.seltzer:com.io7m.seltzer.api:1.0.0 → 1.0.1.
2024-05-10 Change: Update com.io7m.jxtrand.version:2.0.0 → 2.1.0.
2024-03-08 Release: com.io7m.quarrel 1.6.0
2024-03-08 Change: Fix invalid xstructural generation for named parameters.
2024-01-06 Release: com.io7m.quarrel 1.5.0
2024-01-06 Change: Change format of xstructural parameters for better layout.
2023-11-04 Release: com.io7m.quarrel 1.4.0
2023-11-04 Change: Add parameterValueRequireNow for optional parameters.
2023-07-24 Release: com.io7m.quarrel 1.3.0
2023-07-24 Change: Allow string conversion to raise QException.
2023-07-24 Change: Add QException.adapt()
2023-07-24 Change: Add convenient with() method to converter directories.
2023-06-11 Release: com.io7m.quarrel 1.2.0
2023-06-11 Change: Update com.io7m.seltzer:com.io7m.seltzer.api 1.0.0-beta0001 → 1.0.0.
2023-06-11 Change: Update commons-io:commons-io 2.12.0 → 2.13.0.
2023-06-09 Release: com.io7m.quarrel 1.1.0
2023-06-09 Change: Add plusParameters to QLogback.
2023-06-02 Release: com.io7m.quarrel 1.0.0
2023-06-02 Change: Initial major release.

Sources

This project uses Git to manage source code.

Repository: https://www.github.com/io7m-com/quarrel

$ git clone https://www.github.com/io7m-com/quarrel

License

Copyright © 2024 Mark Raynsford <code@io7m.com> https://www.io7m.com

Permission to use, copy, modify, and/or distribute this software for
any purpose with or without fee is hereby granted, provided that the
above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.

Bug Tracker

The project uses GitHub Issues to track issues.