Skip to content

Commit 6c84b3d

Browse files
authored
Add "required" explanation in "--help" of CLI (#23)
1 parent 515a74f commit 6c84b3d

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ Scalar Admin pause tool for the Kubernetes environment
1717
Namespace that Scalar products you want to pause
1818
are deployed. `default` by default.
1919
-r, --release-name=<helmReleaseName>
20-
Helm's release name that you specify when you run
21-
the `helm install <RELEASE_NAME>` command. You
22-
can see the <RELEASE_NAME> by using the `helm
23-
list` command.
20+
Required. The helm release name that you specify
21+
when you run the `helm install <RELEASE_NAME>`
22+
command. You can see the <RELEASE_NAME> by using
23+
the `helm list` command.
2424
-w, --max-pause-wait-time=<maxPauseWaitTime>
2525
The max wait time (in milliseconds) until Scalar
2626
products drain outstanding requests before they

cli/src/main/java/com/scalar/admin/kubernetes/Cli.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ class Cli implements Callable<Integer> {
2828
@Option(
2929
names = {"--release-name", "-r"},
3030
description =
31-
"Helm's release name that you specify when you run the `helm install <RELEASE_NAME>`"
32-
+ " command. You can see the <RELEASE_NAME> by using the `helm list` command.",
31+
"Required. The helm release name that you specify when you run the `helm install"
32+
+ " <RELEASE_NAME>` command. You can see the <RELEASE_NAME> by using the `helm list`"
33+
+ " command.",
3334
required = true)
3435
private String helmReleaseName;
3536

0 commit comments

Comments
 (0)