Skip to content

Issue #4231: jib cli: add doc about jvm options #4430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Issue #4231: jib cli: add doc about jvm options #4430

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions jib-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ The CLI tool is powered by [Jib Core](https://github.com/GoogleContainerTools/ji
* [Download a Java Application](#download-a-java-application)
* [Windows: Install with `choco`](#windows-install-with-choco)
* [Build Yourself from Source (for Advanced Users)](#build-yourself-from-source-for-advanced-users)
* [Jib CLI JVM options](#jib-cli-jvm-options)
* [Supported Commands](#supported-commands)
* [Build Command](#build-command)
* [Quickstart](#quickstart)
Expand Down Expand Up @@ -88,6 +89,12 @@ $ ./gradlew jib-cli:installDist
$ ./jib-cli/build/install/jib/bin/jib
```

## Jib CLI JVM options

Jib CLI is a Java application built with the [Gradle application plugin](https://docs.gradle.org/current/userguide/application_plugin.html).
To configure JVM options for the Jib CLI process itself, you can use the `JIB_OPTS` or `JAVA_OPTS` environment variables.
This is commonly used to configure settings like a proxy by passing standard Java networking properties, as described in the [proxy configuration FAQ](../docs/faq.md#how-do-i-configure-a-proxy).
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The linked FAQ section on proxy configuration is written for the Jib Maven/Gradle plugins and talks about configuring the build tool. This might be confusing for a Jib CLI user.

To improve clarity, I suggest removing the link to the FAQ, providing examples of the properties, and linking to the official Java documentation for networking properties instead.

Suggested change
This is commonly used to configure settings like a proxy by passing standard Java networking properties, as described in the [proxy configuration FAQ](../docs/faq.md#how-do-i-configure-a-proxy).
This is commonly used to configure settings like a proxy by passing standard Java networking properties (e.g., `https.proxyHost` and `https.proxyPort`). For a full list of properties, see the [Java Networking and Proxies documentation](https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html).


## Supported Commands

The Jib CLI supports two commands:
Expand Down