com.io7m.quarrel

quarrel

The quarrel package provides a strict, opinionated command-line argument parser.

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.
• Written in pure Java 21.
• OSGi-ready.
• JPMS-ready.
• ISC license.

Usage

See the documentation.

Releases & Development Snapshots

Releases

You can subscribe to the atom feed to be notified of project releases.

The most recently released version of the package is 1.8.0.

1.8.0 Release (2025-05-09Z)

• Add java.util.Pattern as a default value converter.

The compiled artifacts for the release (and all previous releases) are available on Maven Central.

Maven Modules

<dependency> <group>com.io7m.quarrel</group> <artifactId>com.io7m.quarrel.bom</artifactId> <version>1.8.0</version> </dependency><dependency> <group>com.io7m.quarrel</group> <artifactId>com.io7m.quarrel.core</artifactId> <version>1.8.0</version> </dependency><dependency> <group>com.io7m.quarrel</group> <artifactId>com.io7m.quarrel.documentation</artifactId> <version>1.8.0</version> </dependency><dependency> <group>com.io7m.quarrel</group> <artifactId>com.io7m.quarrel.example</artifactId> <version>1.8.0</version> </dependency><dependency> <group>com.io7m.quarrel</group> <artifactId>com.io7m.quarrel.ext.logback</artifactId> <version>1.8.0</version> </dependency><dependency> <group>com.io7m.quarrel</group> <artifactId>com.io7m.quarrel.ext.xstructural</artifactId> <version>1.8.0</version> </dependency><dependency> <group>com.io7m.quarrel</group> <artifactId>com.io7m.quarrel.tests</artifactId> <version>1.8.0</version> </dependency>

Previous Releases

The changelogs for the most recent previous releases are as follows:

1.7.0 Release (2025-05-07Z)

• Update jqwik.version:1.8.4 → 1.8.5.
• Update jqwik.version:1.8.5 → 1.9.0.
• Update junit.version:5.10.2 → 5.10.3.
• Update com.io7m.seltzer:com.io7m.seltzer.api:1.0.1 → 1.1.0.
• Update org.slf4j:slf4j-api:2.0.13 → 2.0.14.
• Update org.slf4j:slf4j-api:2.0.14 → 2.0.15.
• Update org.slf4j:slf4j-api:2.0.15 → 2.0.16.
• Update junit.version:5.10.3 → 5.11.0.
• Update ch.qos.logback:logback-classic:1.5.6 → 1.5.7.
• Update nl.jqno.equalsverifier:equalsverifier:3.16.1 → 3.16.2.
• Update ch.qos.logback:logback-classic:1.5.7 → 1.5.8.
• Update commons-io:commons-io:2.16.1 → 2.17.0.
• Update junit.version:5.11.0 → 5.11.1.
• Update nl.jqno.equalsverifier:equalsverifier:3.16.2 → 3.17.
• Update jqwik.version:1.9.0 → 1.9.1.
• Update nl.jqno.equalsverifier:equalsverifier:3.17 → 3.17.1.
• Update junit.version:5.11.1 → 5.11.2.
• Update ch.qos.logback:logback-classic:1.5.8 → 1.5.9.
• Update ch.qos.logback:logback-classic:1.5.9 → 1.5.10.
• Update ch.qos.logback:logback-classic:1.5.10 → 1.5.11.
• Update org.junit:junit-bom:5.11.2 → 5.11.3.
• Update ch.qos.logback:logback-classic:1.5.11 → 1.5.12.
• Update nl.jqno.equalsverifier:equalsverifier:3.17.1 → 3.17.2.
• Update nl.jqno.equalsverifier:equalsverifier:3.17.2 → 3.17.3.
• Update commons-io:commons-io:2.17.0 → 2.18.0.
• Update nl.jqno.equalsverifier:equalsverifier:3.17.3 → 3.17.4.
• Update jqwik.version:1.9.1 → 1.9.2.
• Update nl.jqno.equalsverifier:equalsverifier:3.17.4 → 3.17.5.
• Update org.junit:junit-bom:5.11.3 → 5.11.4.
• Update ch.qos.logback:logback-classic:1.5.12 → 1.5.13.
• Update ch.qos.logback:logback-classic:1.5.13 → 1.5.14.
• Update ch.qos.logback:logback-classic:1.5.14 → 1.5.15.
• Update nl.jqno.equalsverifier:equalsverifier:3.17.5 → 3.18.
• Update ch.qos.logback:logback-classic:1.5.15 → 1.5.16.
• Update nl.jqno.equalsverifier:equalsverifier:3.18 → 3.18.1.
• Update codecov/codecov-action:5.1.2 → 5.3.1.
• Update nl.jqno.equalsverifier:equalsverifier:3.18.1 → 3.18.2.
• Update org.slf4j:slf4j-api:2.0.16 → 2.0.17.
• Update ch.qos.logback:logback-classic:1.5.16 → 1.5.18.
• Update org.junit:junit-bom:5.11.4 → 5.12.1.
• Update nl.jqno.equalsverifier:equalsverifier:3.18.2 → 3.19.2.
• Update nl.jqno.equalsverifier:equalsverifier:3.19.2 → 3.19.4.
• Update org.junit:junit-bom:5.12.1 → 5.12.2.
• Update commons-io:commons-io:2.18.0 → 2.19.0.
• Publish a com.io7m.quarrel.bom module.
• Update com.io7m.seltzer:com.io7m.seltzer.api:1.1.0 → 1.2.0.

1.6.1 Release (2024-05-10Z)

• Update nl.jqno.equalsverifier:equalsverifier:3.14.2 → 3.15.8
• Update org.slf4j:slf4j-api:2.0.7 → 2.0.12
• Update ch.qos.logback:logback-classic:1.4.7 → 1.5.3
• Update commons-io:commons-io:2.13.0 → 2.15.1
• Update com.io7m.jxtrand:com.io7m.jxtrand.api:1.1.0 → 2.0.0
• Update com.io7m.jxtrand:com.io7m.jxtrand.vanilla:1.1.0 → 2.0.0
• Update net.jqwik:jqwik-api:1.7.3 → 1.8.4
• Update net.jqwik:jqwik-engine:1.7.3 → 1.8.4
• Update org.junit.jupiter:junit-jupiter-api:5.9.3 → 5.10.2
• Update org.junit.jupiter:junit-jupiter-engine:5.9.3 → 5.10.2
• Update ch.qos.logback:logback-classic:1.5.3 → 1.5.6.
• Update commons-io:commons-io:2.15.1 → 2.16.1.
• Update nl.jqno.equalsverifier:equalsverifier:3.15.8 → 3.16.1.
• Update org.slf4j:slf4j-api:2.0.12 → 2.0.13.
• Update com.io7m.seltzer:com.io7m.seltzer.api:1.0.0 → 1.0.1.
• Update com.io7m.jxtrand.version:2.0.0 → 2.1.0.

1.6.0 Release (2024-03-08Z)

• Fix invalid xstructural generation for named parameters.

1.5.0 Release (2024-01-06Z)

• Change format of xstructural parameters for better layout.

Development Snapshots

At the time of writing, the current unstable development version of the package is 1.9.0-SNAPSHOT.

Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.

Manual

User Manual

• XHTML - One page per section
• XHTML - Single page

Sources

This project uses Git to manage source code.

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

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

Issues

This project uses GitHub Issues to track issues.

License

Copyright © 2023 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.