Skip to content

Commit 48c9cd3

Browse files
committed
cli: Add help text about argument exclusivity
Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
1 parent bca5879 commit 48c9cd3

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,14 @@ optional arguments:
8787
times to increase verbosity (default: 0)
8888
-V, --version show program's version number and exit
8989
--staging Use sigstore's staging instance, instead of the default
90-
production instance (default: False)
90+
production instance. Mutually exclusive with other
91+
instance configuration arguments. (default: False)
9192
--instance URL Use a given Sigstore instance URL, instead of the
92-
default production instance (default: None)
93-
--trust-config FILE The client trust configuration to use (default: None)
93+
default production instance. Mutually exclusive with
94+
other instance configuration arguments. (default: None)
95+
--trust-config FILE The client trust configuration to use. Mutually
96+
exclusive with other instance configuration arguments.
97+
(default: None)
9498
```
9599
<!-- @end-sigstore-help@ -->
96100

sigstore/_cli.py

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -263,19 +263,28 @@ def _parser() -> argparse.ArgumentParser:
263263
"--staging",
264264
action="store_true",
265265
default=_boolify_env("SIGSTORE_STAGING"),
266-
help="Use sigstore's staging instance, instead of the default production instance",
266+
help=(
267+
"Use sigstore's staging instance, instead of the default production instance."
268+
" Mutually exclusive with other instance configuration arguments."
269+
),
267270
)
268271
global_instance_options.add_argument(
269272
"--instance",
270273
metavar="URL",
271274
type=str,
272-
help="Use a given Sigstore instance URL, instead of the default production instance",
275+
help=(
276+
"Use a given Sigstore instance URL, instead of the default production instance."
277+
" Mutually exclusive with other instance configuration arguments."
278+
),
273279
)
274280
global_instance_options.add_argument(
275281
"--trust-config",
276282
metavar="FILE",
277283
type=Path,
278-
help="The client trust configuration to use",
284+
help=(
285+
"Use given client trust configuration, instead of using the default production"
286+
" instance. Mutually exclusive with other instance configuration arguments."
287+
),
279288
)
280289
subcommands = parser.add_subparsers(
281290
required=True,

0 commit comments

Comments
 (0)