From f4a389514305ccb17a16d04edabd841b007de040 Mon Sep 17 00:00:00 2001 From: Austin Abro <37223396+AustinAbro321@users.noreply.github.com> Date: Wed, 20 Nov 2024 15:52:50 -0500 Subject: [PATCH] chore: unhide log-format flag (#3251) Signed-off-by: Austin Abro --- site/src/content/docs/commands/zarf.md | 1 + site/src/content/docs/commands/zarf_completion.md | 1 + site/src/content/docs/commands/zarf_completion_bash.md | 1 + site/src/content/docs/commands/zarf_completion_fish.md | 1 + .../src/content/docs/commands/zarf_completion_powershell.md | 1 + site/src/content/docs/commands/zarf_completion_zsh.md | 1 + site/src/content/docs/commands/zarf_connect.md | 1 + site/src/content/docs/commands/zarf_connect_list.md | 1 + site/src/content/docs/commands/zarf_destroy.md | 1 + site/src/content/docs/commands/zarf_dev.md | 1 + site/src/content/docs/commands/zarf_dev_deploy.md | 1 + site/src/content/docs/commands/zarf_dev_find-images.md | 1 + site/src/content/docs/commands/zarf_dev_generate-config.md | 1 + site/src/content/docs/commands/zarf_dev_generate.md | 1 + site/src/content/docs/commands/zarf_dev_lint.md | 1 + site/src/content/docs/commands/zarf_dev_patch-git.md | 1 + site/src/content/docs/commands/zarf_dev_sha256sum.md | 1 + site/src/content/docs/commands/zarf_init.md | 1 + site/src/content/docs/commands/zarf_package.md | 1 + site/src/content/docs/commands/zarf_package_create.md | 1 + site/src/content/docs/commands/zarf_package_deploy.md | 1 + site/src/content/docs/commands/zarf_package_inspect.md | 1 + site/src/content/docs/commands/zarf_package_list.md | 1 + .../content/docs/commands/zarf_package_mirror-resources.md | 1 + site/src/content/docs/commands/zarf_package_publish.md | 1 + site/src/content/docs/commands/zarf_package_pull.md | 1 + site/src/content/docs/commands/zarf_package_remove.md | 1 + site/src/content/docs/commands/zarf_tools.md | 1 + site/src/content/docs/commands/zarf_tools_archiver.md | 1 + .../content/docs/commands/zarf_tools_archiver_compress.md | 1 + .../content/docs/commands/zarf_tools_archiver_decompress.md | 1 + .../content/docs/commands/zarf_tools_archiver_version.md | 1 + site/src/content/docs/commands/zarf_tools_clear-cache.md | 1 + site/src/content/docs/commands/zarf_tools_download-init.md | 1 + site/src/content/docs/commands/zarf_tools_gen-key.md | 1 + site/src/content/docs/commands/zarf_tools_gen-pki.md | 1 + site/src/content/docs/commands/zarf_tools_get-creds.md | 1 + site/src/content/docs/commands/zarf_tools_update-creds.md | 1 + site/src/content/docs/commands/zarf_version.md | 1 + src/cmd/internal.go | 1 + src/cmd/root.go | 6 +----- 41 files changed, 41 insertions(+), 5 deletions(-) diff --git a/site/src/content/docs/commands/zarf.md b/site/src/content/docs/commands/zarf.md index 0ed3312946..2abaf2d473 100644 --- a/site/src/content/docs/commands/zarf.md +++ b/site/src/content/docs/commands/zarf.md @@ -25,6 +25,7 @@ zarf COMMAND [flags] -a, --architecture string Architecture for OCI images and Zarf packages -h, --help help for zarf --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_completion.md b/site/src/content/docs/commands/zarf_completion.md index 99a58b833a..dfeb5e7d08 100644 --- a/site/src/content/docs/commands/zarf_completion.md +++ b/site/src/content/docs/commands/zarf_completion.md @@ -27,6 +27,7 @@ See each sub-command's help for details on how to use the generated script. ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_completion_bash.md b/site/src/content/docs/commands/zarf_completion_bash.md index 349bbf7e0a..01a8516499 100644 --- a/site/src/content/docs/commands/zarf_completion_bash.md +++ b/site/src/content/docs/commands/zarf_completion_bash.md @@ -50,6 +50,7 @@ zarf completion bash ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_completion_fish.md b/site/src/content/docs/commands/zarf_completion_fish.md index de3f70b160..7b6953dece 100644 --- a/site/src/content/docs/commands/zarf_completion_fish.md +++ b/site/src/content/docs/commands/zarf_completion_fish.md @@ -41,6 +41,7 @@ zarf completion fish [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_completion_powershell.md b/site/src/content/docs/commands/zarf_completion_powershell.md index 53add1dc9a..880f91bac3 100644 --- a/site/src/content/docs/commands/zarf_completion_powershell.md +++ b/site/src/content/docs/commands/zarf_completion_powershell.md @@ -38,6 +38,7 @@ zarf completion powershell [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_completion_zsh.md b/site/src/content/docs/commands/zarf_completion_zsh.md index 94bdf43f4d..2806b879c5 100644 --- a/site/src/content/docs/commands/zarf_completion_zsh.md +++ b/site/src/content/docs/commands/zarf_completion_zsh.md @@ -52,6 +52,7 @@ zarf completion zsh [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_connect.md b/site/src/content/docs/commands/zarf_connect.md index 1b504873ab..d4ee6637b1 100644 --- a/site/src/content/docs/commands/zarf_connect.md +++ b/site/src/content/docs/commands/zarf_connect.md @@ -41,6 +41,7 @@ zarf connect { REGISTRY | GIT | connect-name } [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_connect_list.md b/site/src/content/docs/commands/zarf_connect_list.md index 8829b812e0..51cece492e 100644 --- a/site/src/content/docs/commands/zarf_connect_list.md +++ b/site/src/content/docs/commands/zarf_connect_list.md @@ -25,6 +25,7 @@ zarf connect list [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_destroy.md b/site/src/content/docs/commands/zarf_destroy.md index 64608f4e58..5515c30c58 100644 --- a/site/src/content/docs/commands/zarf_destroy.md +++ b/site/src/content/docs/commands/zarf_destroy.md @@ -37,6 +37,7 @@ zarf destroy --confirm [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_dev.md b/site/src/content/docs/commands/zarf_dev.md index 0dd4d1e4f1..2669e39b67 100644 --- a/site/src/content/docs/commands/zarf_dev.md +++ b/site/src/content/docs/commands/zarf_dev.md @@ -21,6 +21,7 @@ Commands useful for developing packages ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_dev_deploy.md b/site/src/content/docs/commands/zarf_dev_deploy.md index b08c142478..e0e1842db7 100644 --- a/site/src/content/docs/commands/zarf_dev_deploy.md +++ b/site/src/content/docs/commands/zarf_dev_deploy.md @@ -38,6 +38,7 @@ zarf dev deploy [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_dev_find-images.md b/site/src/content/docs/commands/zarf_dev_find-images.md index a5f94578ee..7c1eb61b39 100644 --- a/site/src/content/docs/commands/zarf_dev_find-images.md +++ b/site/src/content/docs/commands/zarf_dev_find-images.md @@ -39,6 +39,7 @@ zarf dev find-images [ PACKAGE ] [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_dev_generate-config.md b/site/src/content/docs/commands/zarf_dev_generate-config.md index cb5040f133..86878db2b9 100644 --- a/site/src/content/docs/commands/zarf_dev_generate-config.md +++ b/site/src/content/docs/commands/zarf_dev_generate-config.md @@ -34,6 +34,7 @@ zarf dev generate-config [ FILENAME ] [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_dev_generate.md b/site/src/content/docs/commands/zarf_dev_generate.md index 58ffc1102f..6f82e67995 100644 --- a/site/src/content/docs/commands/zarf_dev_generate.md +++ b/site/src/content/docs/commands/zarf_dev_generate.md @@ -36,6 +36,7 @@ zarf dev generate podinfo --url https://github.com/stefanprodan/podinfo.git --ve ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_dev_lint.md b/site/src/content/docs/commands/zarf_dev_lint.md index 57827ee0ed..753362c5ef 100644 --- a/site/src/content/docs/commands/zarf_dev_lint.md +++ b/site/src/content/docs/commands/zarf_dev_lint.md @@ -31,6 +31,7 @@ zarf dev lint [ DIRECTORY ] [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_dev_patch-git.md b/site/src/content/docs/commands/zarf_dev_patch-git.md index 4a3b2553d0..f4de661dab 100644 --- a/site/src/content/docs/commands/zarf_dev_patch-git.md +++ b/site/src/content/docs/commands/zarf_dev_patch-git.md @@ -27,6 +27,7 @@ zarf dev patch-git HOST FILE [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_dev_sha256sum.md b/site/src/content/docs/commands/zarf_dev_sha256sum.md index 91419a9665..41b1d3f77e 100644 --- a/site/src/content/docs/commands/zarf_dev_sha256sum.md +++ b/site/src/content/docs/commands/zarf_dev_sha256sum.md @@ -26,6 +26,7 @@ zarf dev sha256sum { FILE | URL } [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_init.md b/site/src/content/docs/commands/zarf_init.md index 0f14453100..7a448e9281 100644 --- a/site/src/content/docs/commands/zarf_init.md +++ b/site/src/content/docs/commands/zarf_init.md @@ -86,6 +86,7 @@ $ zarf init --artifact-push-password={PASSWORD} --artifact-push-username={USERNA ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_package.md b/site/src/content/docs/commands/zarf_package.md index a8d1244e58..37ba5dfdf9 100644 --- a/site/src/content/docs/commands/zarf_package.md +++ b/site/src/content/docs/commands/zarf_package.md @@ -23,6 +23,7 @@ Zarf package commands for creating, deploying, and inspecting packages ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_package_create.md b/site/src/content/docs/commands/zarf_package_create.md index b3ef73bb78..7fe3f104ae 100644 --- a/site/src/content/docs/commands/zarf_package_create.md +++ b/site/src/content/docs/commands/zarf_package_create.md @@ -44,6 +44,7 @@ zarf package create [ DIRECTORY ] [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_package_deploy.md b/site/src/content/docs/commands/zarf_package_deploy.md index 4ebbe054c6..c423cad9ce 100644 --- a/site/src/content/docs/commands/zarf_package_deploy.md +++ b/site/src/content/docs/commands/zarf_package_deploy.md @@ -39,6 +39,7 @@ zarf package deploy [ PACKAGE_SOURCE ] [flags] -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_package_inspect.md b/site/src/content/docs/commands/zarf_package_inspect.md index 8881bbe248..833011a813 100644 --- a/site/src/content/docs/commands/zarf_package_inspect.md +++ b/site/src/content/docs/commands/zarf_package_inspect.md @@ -34,6 +34,7 @@ zarf package inspect [ PACKAGE_SOURCE ] [flags] -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_package_list.md b/site/src/content/docs/commands/zarf_package_list.md index 4fddd0dd13..233335dac3 100644 --- a/site/src/content/docs/commands/zarf_package_list.md +++ b/site/src/content/docs/commands/zarf_package_list.md @@ -26,6 +26,7 @@ zarf package list [flags] -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_package_mirror-resources.md b/site/src/content/docs/commands/zarf_package_mirror-resources.md index 20a60964ab..659a1b7bd9 100644 --- a/site/src/content/docs/commands/zarf_package_mirror-resources.md +++ b/site/src/content/docs/commands/zarf_package_mirror-resources.md @@ -67,6 +67,7 @@ $ zarf package mirror-resources \ -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_package_publish.md b/site/src/content/docs/commands/zarf_package_publish.md index 310e4481c5..0ebfdb3516 100644 --- a/site/src/content/docs/commands/zarf_package_publish.md +++ b/site/src/content/docs/commands/zarf_package_publish.md @@ -41,6 +41,7 @@ $ zarf package publish ./path/to/dir oci://my-registry.com/my-namespace -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_package_pull.md b/site/src/content/docs/commands/zarf_package_pull.md index 81bee3464c..1b87e49a33 100644 --- a/site/src/content/docs/commands/zarf_package_pull.md +++ b/site/src/content/docs/commands/zarf_package_pull.md @@ -42,6 +42,7 @@ $ zarf package pull oci://ghcr.io/defenseunicorns/packages/dos-games:1.0.0 -a sk -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_package_remove.md b/site/src/content/docs/commands/zarf_package_remove.md index edebd01408..104484e18c 100644 --- a/site/src/content/docs/commands/zarf_package_remove.md +++ b/site/src/content/docs/commands/zarf_package_remove.md @@ -29,6 +29,7 @@ zarf package remove { PACKAGE_SOURCE | PACKAGE_NAME } --confirm [flags] -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_tools.md b/site/src/content/docs/commands/zarf_tools.md index 51e9e472d1..e770789a98 100644 --- a/site/src/content/docs/commands/zarf_tools.md +++ b/site/src/content/docs/commands/zarf_tools.md @@ -21,6 +21,7 @@ Collection of additional tools to make airgap easier ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_tools_archiver.md b/site/src/content/docs/commands/zarf_tools_archiver.md index edd7615755..9a17c3d5a2 100644 --- a/site/src/content/docs/commands/zarf_tools_archiver.md +++ b/site/src/content/docs/commands/zarf_tools_archiver.md @@ -21,6 +21,7 @@ Compresses/Decompresses generic archives, including Zarf packages ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_tools_archiver_compress.md b/site/src/content/docs/commands/zarf_tools_archiver_compress.md index de2cc0518a..9de8388512 100644 --- a/site/src/content/docs/commands/zarf_tools_archiver_compress.md +++ b/site/src/content/docs/commands/zarf_tools_archiver_compress.md @@ -25,6 +25,7 @@ zarf tools archiver compress SOURCES ARCHIVE [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_tools_archiver_decompress.md b/site/src/content/docs/commands/zarf_tools_archiver_decompress.md index ead2ce66ac..05f0687f61 100644 --- a/site/src/content/docs/commands/zarf_tools_archiver_decompress.md +++ b/site/src/content/docs/commands/zarf_tools_archiver_decompress.md @@ -26,6 +26,7 @@ zarf tools archiver decompress ARCHIVE DESTINATION [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_tools_archiver_version.md b/site/src/content/docs/commands/zarf_tools_archiver_version.md index 169ece563b..86f490e7b3 100644 --- a/site/src/content/docs/commands/zarf_tools_archiver_version.md +++ b/site/src/content/docs/commands/zarf_tools_archiver_version.md @@ -25,6 +25,7 @@ zarf tools archiver version [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_tools_clear-cache.md b/site/src/content/docs/commands/zarf_tools_clear-cache.md index c2e7f8d94e..3e41fba093 100644 --- a/site/src/content/docs/commands/zarf_tools_clear-cache.md +++ b/site/src/content/docs/commands/zarf_tools_clear-cache.md @@ -26,6 +26,7 @@ zarf tools clear-cache [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_tools_download-init.md b/site/src/content/docs/commands/zarf_tools_download-init.md index 723c4d3d83..b6a616a80e 100644 --- a/site/src/content/docs/commands/zarf_tools_download-init.md +++ b/site/src/content/docs/commands/zarf_tools_download-init.md @@ -26,6 +26,7 @@ zarf tools download-init [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_tools_gen-key.md b/site/src/content/docs/commands/zarf_tools_gen-key.md index 421f4029ad..93805806a7 100644 --- a/site/src/content/docs/commands/zarf_tools_gen-key.md +++ b/site/src/content/docs/commands/zarf_tools_gen-key.md @@ -25,6 +25,7 @@ zarf tools gen-key [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_tools_gen-pki.md b/site/src/content/docs/commands/zarf_tools_gen-pki.md index 641fe08402..cdba8d052b 100644 --- a/site/src/content/docs/commands/zarf_tools_gen-pki.md +++ b/site/src/content/docs/commands/zarf_tools_gen-pki.md @@ -26,6 +26,7 @@ zarf tools gen-pki HOST [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_tools_get-creds.md b/site/src/content/docs/commands/zarf_tools_get-creds.md index 8d8511ffb3..89b6b4c21f 100644 --- a/site/src/content/docs/commands/zarf_tools_get-creds.md +++ b/site/src/content/docs/commands/zarf_tools_get-creds.md @@ -45,6 +45,7 @@ $ zarf tools get-creds artifact ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_tools_update-creds.md b/site/src/content/docs/commands/zarf_tools_update-creds.md index 6ff620ea1a..50c3b0e037 100644 --- a/site/src/content/docs/commands/zarf_tools_update-creds.md +++ b/site/src/content/docs/commands/zarf_tools_update-creds.md @@ -74,6 +74,7 @@ $ zarf tools update-creds artifact --artifact-push-username={USERNAME} --artifac ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/site/src/content/docs/commands/zarf_version.md b/site/src/content/docs/commands/zarf_version.md index ab3859c1ec..8448928de4 100644 --- a/site/src/content/docs/commands/zarf_version.md +++ b/site/src/content/docs/commands/zarf_version.md @@ -30,6 +30,7 @@ zarf version [flags] ``` -a, --architecture string Architecture for OCI images and Zarf packages --insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture. + --log-format string [alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev' -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output --no-log-file Disable log file creation diff --git a/src/cmd/internal.go b/src/cmd/internal.go index b3bc2c4592..685248e149 100644 --- a/src/cmd/internal.go +++ b/src/cmd/internal.go @@ -85,6 +85,7 @@ var genCLIDocs = &cobra.Command{ // If the command is a vendored command, add a dummy flag to hide root flags from the docs if common.CheckVendorOnlyFromPath(toolCmd) { addHiddenDummyFlag(toolCmd, "log-level") + addHiddenDummyFlag(toolCmd, "log-format") addHiddenDummyFlag(toolCmd, "architecture") addHiddenDummyFlag(toolCmd, "no-log-file") addHiddenDummyFlag(toolCmd, "no-progress") diff --git a/src/cmd/root.go b/src/cmd/root.go index 6fb0b5f9fb..922a015126 100644 --- a/src/cmd/root.go +++ b/src/cmd/root.go @@ -164,7 +164,7 @@ func init() { // Logs rootCmd.PersistentFlags().StringVarP(&LogLevelCLI, "log-level", "l", v.GetString(common.VLogLevel), lang.RootCmdFlagLogLevel) - rootCmd.PersistentFlags().StringVar(&LogFormat, "log-format", v.GetString(common.VLogFormat), "Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json'") + rootCmd.PersistentFlags().StringVar(&LogFormat, "log-format", v.GetString(common.VLogFormat), "[alpha] Select a logging format. Defaults to 'text'. Valid options are: 'text', 'json', 'console', 'dev'") rootCmd.PersistentFlags().BoolVar(&SkipLogFile, "no-log-file", v.GetBool(common.VNoLogFile), lang.RootCmdFlagSkipLogFile) rootCmd.PersistentFlags().BoolVar(&message.NoProgress, "no-progress", v.GetBool(common.VNoProgress), lang.RootCmdFlagNoProgress) rootCmd.PersistentFlags().BoolVar(&NoColor, "no-color", v.GetBool(common.VNoColor), lang.RootCmdFlagNoColor) @@ -178,10 +178,6 @@ func init() { rootCmd.PersistentFlags().MarkDeprecated("insecure", "please use --plain-http, --insecure-skip-tls-verify, or --skip-signature-validation instead.") rootCmd.PersistentFlags().BoolVar(&config.CommonOptions.PlainHTTP, "plain-http", v.GetBool(common.VPlainHTTP), lang.RootCmdFlagPlainHTTP) rootCmd.PersistentFlags().BoolVar(&config.CommonOptions.InsecureSkipTLSVerify, "insecure-skip-tls-verify", v.GetBool(common.VInsecureSkipTLSVerify), lang.RootCmdFlagInsecureSkipTLSVerify) - - // HACK(mkcp): This is a workaround for us testing that help output matches to the byte. Undo this and update tests - // before release. - rootCmd.PersistentFlags().MarkHidden("log-format") } // setup Logger handles creating a logger and setting it as the global default.