diff --git a/doc/source/cli/cli.rst b/doc/source/cli/cli.rst index f13b0479..531c238d 100644 --- a/doc/source/cli/cli.rst +++ b/doc/source/cli/cli.rst @@ -296,6 +296,10 @@ List known sites. Location where the output is saved. +**-o / \\-\\-output** (Optional). + +Same as -s (--save-location). Deprecated. + :: ./pegleg list @@ -322,6 +326,10 @@ Name of site. Location where the output is saved. +**-o / \\-\\-output** (Optional). + +Same as -s (--save-location). Deprecated. + :: ./pegleg show site_name @@ -348,6 +356,10 @@ Name of site. Location where the output is saved. +**-o / \\-\\-output** (Optional). + +Same as -s (--save-location). Deprecated. + **-v / \\-\\-validate** (Optional, Default=True). Whether to pre-validate documents using built-in schema validation. @@ -779,6 +791,10 @@ The relative path to the file to be wrapped. The output path where the wrapped file is saved. (default: input path with the extension replaced with .yaml) +**-o / \\-\\-output-path** + +Same as --save-location. Deprecated. + **-s / \\-\\-schema** The schema for the document to be wrapped, e.g. deckhand/Certificate/v1 diff --git a/pegleg/cli/commands.py b/pegleg/cli/commands.py index 58e8b0c5..c7fceab0 100644 --- a/pegleg/cli/commands.py +++ b/pegleg/cli/commands.py @@ -332,11 +332,13 @@ def generate_pki_deprecated(site_name, author, days, regenerate_all): 'filename', help='The relative file path for the file to be wrapped.') @click.option( + '-o', # DEPRECATED + '--output-path', # DEPRECATED '--save-location', 'save_location', required=False, help='The output path where the wrapped file is saved. (default: input ' - 'path with .yaml).') + 'path with .yaml). -o (--output-path) is deprecated and will be removed.') @click.option( '-s', '--schema', diff --git a/pegleg/cli/utils.py b/pegleg/cli/utils.py index 2cba0d7e..ee712e5e 100644 --- a/pegleg/cli/utils.py +++ b/pegleg/cli/utils.py @@ -92,8 +92,11 @@ MAIN_REPOSITORY_OPTION = click.option( SAVE_LOCATION_OPTION = click.option( '-s', '--save-location', + '-o', # DEPRECATED + '--output', # DEPRECATED 'save_location', - help='Where to save the output. Defaults to stdout.') + help='Where to save the output. Defaults to stdout. ' + '-o (--output) is deprecated and will be removed.') REPOSITORY_CLONE_PATH_OPTION = click.option( '-p',