Skip to main content
Version: 2.23 (prerelease)

jar_tool

The Java Archive Tool

Backend: pants.backend.experimental.java.debug_goals

Config section: [jar_tool]

Basic options​

None

Advanced options​

artifacts​

--jar_tool-artifacts="['<str>', '<str>', ...]"
PANTS_JAR_TOOL_ARTIFACTS
pants.toml
[jar_tool]
artifacts = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "args4j:args4j:2.33",
  "com.google.code.findbugs:jsr305:3.0.2",
  "com.google.guava:guava:18.0"
]

Artifact requirements for this tool using specified as either the address of a jvm_artifact target or, alternatively, as a colon-separated Maven coordinates (e.g., group:name:version). For Maven coordinates, the string {version} version will be substituted with the value of the [jar_tool].version option.

jvm_options​

--jar_tool-jvm-options="['<str>', '<str>', ...]"
PANTS_JAR_TOOL_JVM_OPTIONS
pants.toml
[jar_tool]
jvm_options = [
    '<str>',
    '<str>',
    ...,
]
default: []

List of JVM options to pass to jar_tool JVM processes.

Options set here will be added to those set in [jvm].global_options. Please check the documentation for the jvm subsystem to see what values are accepted here.

lockfile​

--jar_tool-lockfile=<str>
PANTS_JAR_TOOL_LOCKFILE
pants.toml
[jar_tool]
lockfile = <str>
default: <default>

Path to a lockfile used for installing the tool.

Set to the string <default> to use a lockfile provided by Pants, so long as you have not changed the --version option. See https://github.com/pantsbuild/pants/blob/release_2.23.0rc3/src/python/pants/jvm/jar_tool/jar_tool.lock for the default lockfile contents.

To use a custom lockfile, set this option to a file path relative to the build root, then run pants jvm-generate-lockfiles --resolve=jar_tool.

version​

--jar_tool-version=<str>
PANTS_JAR_TOOL_VERSION
pants.toml
[jar_tool]
version = <str>
default: None

Version string for the tool. This is available for substitution in the [jar_tool].artifacts option by including the string {version}.

Deprecated options​

None

None