mirrors/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2025-08-18 04:27:02 +02:00
Code Issues Projects Releases Wiki Activity
e56c075c2b
vault/command
History
Alexander Scheel 2e2fa9f648
Write explicit -help output to stdout (#17308) 
* Write explicit -help output to stdout

Per the consensus of most programs, and mirroring the GNU Coding
Standards for CLI design, when users request -help explicitly via the
CLI, this should be written to stdout to allow paging of output. stderr
is fine when an invalid usage triggers the help text however.

In our case, mitchellh/cli helpfully adds a HelpWriter that we
previously set to stderr explicitly. This writer is only called to print
user-requested help text; it is not called on error cases (e.g., bad
usage triggering additional help text to the user).

Thus it should safely be settable to stdout, enabling pagers without
additional redirects.

Notably, we do have to set ErrorWriter as it defaults to initializing to
the value of HelpWriter, which we want to set to stdout now, which is
less useful.

See also: https://www.gnu.org/prep/standards/html_node/_002d_002dhelp.html
Resolves: #17004

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add changelog

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2022-09-26 12:15:48 -04:00
..
agent agent: Fix missing file suffix in config test (#17245) 2022-09-21 11:30:04 -04:00
config dev docs: clarify internal and external token helpers (#13014) 2022-08-16 16:48:24 -04:00
server OSS portion of wrapper-v2 (#16811) 2022-08-23 15:37:16 -04:00
test-fixtures Remove config from Meta; it's only used right now with the token helper. 2016-04-01 16:02:18 -04:00
token update gofumpt to 0.3.1 and reformat the repo (#17055) 2022-09-07 17:31:20 -07:00
agent_test.go Use %q for quoted strings where appropriate (#15216) 2022-08-03 12:32:45 -06:00
agent.go agent/auto-auth: add exit_on_err configurable (#17091) 2022-09-15 11:00:31 -07:00
approle_concurrency_integ_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
audit_disable_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
audit_disable.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
audit_enable_test.go command/audit: improve audit enable type missing error message (#16409) 2022-07-21 16:43:50 -04:00
audit_enable.go command/audit: improve audit enable type missing error message (#16409) 2022-07-21 16:43:50 -04:00
audit_list_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
audit_list.go cleanup unused code and fix t.Fatal usage in goroutine in testing (#11694) 2021-09-30 07:33:14 -04:00
audit.go fix typo (#6469) 2019-03-25 10:56:04 -07:00
auth_disable_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
auth_disable.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
auth_enable_test.go Handle deprecated builtins (#17005) 2022-09-06 15:49:35 -04:00
auth_enable.go CLI: Tune plugin version for auth/secret mounts (#17277) 2022-09-22 20:55:46 +01:00
auth_help_test.go Always use a local test server (#4207) 2018-03-28 10:34:37 -04:00
auth_help.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
auth_list_test.go Add new auth-list command 2017-10-24 09:28:06 -04:00
auth_list.go CLI: Add version info to auth/secrets list -detailed (#17293) 2022-09-23 10:40:42 +01:00
auth_move_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
auth_move.go remount cli changes (#14159) 2022-02-18 08:50:05 -08:00
auth_test.go Remove deprecated CLI commands (#6112) 2019-02-14 11:54:47 -08:00
auth_tune_test.go CLI: Tune plugin version for auth/secret mounts (#17277) 2022-09-22 20:55:46 +01:00
auth_tune.go CLI: Tune plugin version for auth/secret mounts (#17277) 2022-09-22 20:55:46 +01:00
auth.go Remove deprecated CLI commands (#6112) 2019-02-14 11:54:47 -08:00
base_flags_test.go cleanup unused code and fix t.Fatal usage in goroutine in testing (#11694) 2021-09-30 07:33:14 -04:00
base_flags.go Fix integer overflows with new parseutil (#15437) 2022-05-16 13:57:19 -04:00
base_helpers_test.go CLI: Fix erroneous warning when reading from stdin (#17252) 2022-09-21 21:04:49 +01:00
base_helpers.go CLI: Fix erroneous warning when reading from stdin (#17252) 2022-09-21 21:04:49 +01:00
base_predict_test.go Make key completion work for both kv-v1 and kv-v2 (#16553) 2022-09-13 12:11:00 -04:00
base_predict.go Make key completion work for both kv-v1 and kv-v2 (#16553) 2022-09-13 12:11:00 -04:00
base_test.go CLI: add new -header option to be able to add headers to all cli requests #8754 (#12508) 2021-10-27 11:04:04 -04:00
base.go Env Flag Filtering (#16683) 2022-08-17 21:29:16 -04:00
command_test.go Make key completion work for both kv-v1 and kv-v2 (#16553) 2022-09-13 12:11:00 -04:00
commands_nonwindows.go Convert to Go 1.17 go:build directive (#13579) 2022-01-05 12:02:03 -06:00
commands_windows.go Convert to Go 1.17 go:build directive (#13579) 2022-01-05 12:02:03 -06:00
commands.go CLI: Tune plugin version for auth/secret mounts (#17277) 2022-09-22 20:55:46 +01:00
config_test.go Fix output-related tests (#4288) 2018-04-05 20:43:29 -04:00
config.go Move checkHCLKeys into hclutil (#4749) 2018-06-12 12:38:08 -04:00
debug_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
debug.go command/debug: fix bug where monitor was not honoring configured duration (#16834) 2022-08-23 17:09:30 -04:00
delete_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
delete.go vault delete should allow the same output options as vault write,… (#11992) 2021-07-06 10:36:07 -04:00
format_test.go Add build date (#14957) 2022-04-19 14:28:08 -04:00
format.go HCP link integration (#16939) 2022-09-06 14:11:04 -04:00
kv_delete.go Mount flag syntax to mitigate confusion from KV-v2 path discrepancies (#14807) 2022-04-06 13:58:06 -07:00
kv_destroy.go Mount flag syntax to mitigate confusion from KV-v2 path discrepancies (#14807) 2022-04-06 13:58:06 -07:00
kv_enable_versioning.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
kv_get.go Make key completion work for both kv-v1 and kv-v2 (#16553) 2022-09-13 12:11:00 -04:00
kv_helpers.go Global flag that outputs minimum policy HCL required for an operation (#14899) 2022-04-27 16:35:18 -07:00
kv_list.go Typo and clarity fixes (#14081) 2022-02-15 10:43:49 -08:00
kv_metadata_delete.go Mount flag syntax to mitigate confusion from KV-v2 path discrepancies (#14807) 2022-04-06 13:58:06 -07:00
kv_metadata_get.go Mount flag syntax to mitigate confusion from KV-v2 path discrepancies (#14807) 2022-04-06 13:58:06 -07:00
kv_metadata_patch_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
kv_metadata_patch.go Mount flag syntax to mitigate confusion from KV-v2 path discrepancies (#14807) 2022-04-06 13:58:06 -07:00
kv_metadata_put_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
kv_metadata_put.go Mount flag syntax to mitigate confusion from KV-v2 path discrepancies (#14807) 2022-04-06 13:58:06 -07:00
kv_metadata.go Mount flag syntax to mitigate confusion from KV-v2 path discrepancies (#14807) 2022-04-06 13:58:06 -07:00
kv_patch.go Make key completion work for both kv-v1 and kv-v2 (#16553) 2022-09-13 12:11:00 -04:00
kv_put.go Make key completion work for both kv-v1 and kv-v2 (#16553) 2022-09-13 12:11:00 -04:00
kv_rollback.go Mount flag syntax to mitigate confusion from KV-v2 path discrepancies (#14807) 2022-04-06 13:58:06 -07:00
kv_test.go ignore leading slash in kv get command (#16443) 2022-07-28 14:11:58 -04:00
kv_undelete.go Mount flag syntax to mitigate confusion from KV-v2 path discrepancies (#14807) 2022-04-06 13:58:06 -07:00
kv.go Mount flag syntax to mitigate confusion from KV-v2 path discrepancies (#14807) 2022-04-06 13:58:06 -07:00
lease_lookup_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
lease_lookup.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
lease_renew_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
lease_renew.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
lease_revoke_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
lease_revoke.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
lease.go Add lease subcommand 2017-10-24 09:30:47 -04:00
list_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
list.go Vault CLI: show detailed information with ListResponseWithInfo (#15417) 2022-05-18 13:00:50 -04:00
login_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
login.go Minor grammar correction in help for login command (#16211) 2022-07-06 09:17:11 -07:00
main.go Write explicit -help output to stdout (#17308) 2022-09-26 12:15:48 -04:00
monitor_test.go cleanup unused code and fix t.Fatal usage in goroutine in testing (#11694) 2021-09-30 07:33:14 -04:00
monitor.go api/monitor: Adding log format to monitor command and debug (#15536) 2022-05-24 13:10:53 -04:00
namespace_api_lock.go API Lock CLI OSS port (#12925) 2021-10-26 10:52:29 -06:00
namespace_api_unlock.go API Lock CLI OSS port (#12925) 2021-10-26 10:52:29 -06:00
namespace_create.go VAULT-7256: Add custom_metadata to namespaces (#16640) 2022-08-09 11:38:03 -04:00
namespace_delete.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
namespace_list.go cleanup unused code and fix t.Fatal usage in goroutine in testing (#11694) 2021-09-30 07:33:14 -04:00
namespace_lookup.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
namespace_patch.go fix namespace patch not found error message (#17242) 2022-09-23 10:41:11 -04:00
namespace.go VAULT-7256: Add custom_metadata to namespaces (#16640) 2022-08-09 11:38:03 -04:00
operator_diagnose_test.go Vault-6037 making filesystem permissions check opt-in (#15452) 2022-05-17 11:34:31 -07:00
operator_diagnose.go updating hcp link structs, and fix diagnose (#17097) 2022-09-12 11:10:01 -04:00
operator_generate_root_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
operator_generate_root.go Add helper for encoding/decoding root tokens and OTP generation in SDK module (#10504) (#10505) 2021-12-01 08:05:49 -05:00
operator_init_test.go Validate parameters for vault operator init (#16379) 2022-07-25 12:45:04 -07:00
operator_init.go Validate parameters for vault operator init (#16379) 2022-07-25 12:45:04 -07:00
operator_key_status_test.go Always use a local test server (#4207) 2018-03-28 10:34:37 -04:00
operator_key_status.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
operator_members.go Add autopilot automated upgrades and redundancy zones (#15521) 2022-05-20 16:49:11 -04:00
operator_migrate_test.go Migrate to sdk/internalshared libs in go-secure-stdlib (#12090) 2021-07-15 20:17:31 -04:00
operator_migrate.go Use %q for quoted strings where appropriate (#15216) 2022-08-03 12:32:45 -06:00
operator_raft_autopilot_get_config.go Add autopilot automated upgrades and redundancy zones (#15521) 2022-05-20 16:49:11 -04:00
operator_raft_autopilot_set_config.go Add autopilot automated upgrades and redundancy zones (#15521) 2022-05-20 16:49:11 -04:00
operator_raft_autopilot_state.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
operator_raft_join.go Use %q for quoted strings where appropriate (#15216) 2022-08-03 12:32:45 -06:00
operator_raft_listpeers.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
operator_raft_remove_peer.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
operator_raft_snapshot_restore.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
operator_raft_snapshot_save.go Fixing excessive unix file permissions (#14791) 2022-04-01 12:57:38 -04:00
operator_raft_snapshot.go Raft cli docs (#8548) 2020-03-17 09:46:44 -04:00
operator_raft.go Raft cli docs (#8548) 2020-03-17 09:46:44 -04:00
operator_rekey_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
operator_rekey.go Rename master key to root key (#13324) 2021-12-06 17:12:20 -08:00
operator_seal_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
operator_seal.go Rename master key to root key (#13324) 2021-12-06 17:12:20 -08:00
operator_step_down_test.go Add "operator" subcommand 2017-10-24 09:30:48 -04:00
operator_step_down.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
operator_unseal_test.go Vault CLI: show detailed information with ListResponseWithInfo (#15417) 2022-05-18 13:00:50 -04:00
operator_unseal.go Rename master key to root key (#13324) 2021-12-06 17:12:20 -08:00
operator_usage.go Global flag that outputs minimum policy HCL required for an operation (#14899) 2022-04-27 16:35:18 -07:00
operator.go Add "operator" subcommand 2017-10-24 09:30:48 -04:00
path_help_test.go Fix bad rebase 2017-10-24 09:39:34 -04:00
path_help.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
path_map_upgrade_api_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
pgp_test.go fix: PGP subkeys support (#16224) 2022-09-22 09:12:41 -04:00
plugin_deregister_test.go Update mount table and CLI with plugin version for auth (#16856) 2022-08-31 19:23:05 +01:00
plugin_deregister.go Plugins: Consistently use plugin_version (#17171) 2022-09-20 12:35:50 +01:00
plugin_info_test.go Update mount table and CLI with plugin version for auth (#16856) 2022-08-31 19:23:05 +01:00
plugin_info.go Add deprecation status to plugin api and cli (#17077) 2022-09-09 16:03:07 -04:00
plugin_list_test.go Run all builtins as plugins (#5536) 2018-11-06 17:21:24 -08:00
plugin_list.go Add deprecation status to plugin api and cli (#17077) 2022-09-09 16:03:07 -04:00
plugin_register_test.go CLI: Tune plugin version for auth/secret mounts (#17277) 2022-09-22 20:55:46 +01:00
plugin_register.go Plugins: Consistently use plugin_version (#17171) 2022-09-20 12:35:50 +01:00
plugin_reload_status.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
plugin_reload_test.go Update mount table and CLI with plugin version for auth (#16856) 2022-08-31 19:23:05 +01:00
plugin_reload.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
plugin_test.go Update mount table and CLI with plugin version for auth (#16856) 2022-08-31 19:23:05 +01:00
plugin.go Run all builtins as plugins (#5536) 2018-11-06 17:21:24 -08:00
policy_delete_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
policy_delete.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
policy_fmt_test.go Fix output-related tests (#4288) 2018-04-05 20:43:29 -04:00
policy_fmt.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
policy_list_test.go Add "policy" subcommand 2017-10-24 09:30:48 -04:00
policy_list.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
policy_read_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
policy_read.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
policy_write_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
policy_write.go Warn on upper case in policy name (#14670) 2022-03-24 13:29:11 -07:00
policy.go Fix minor docs and help text issues (#4184) 2018-03-22 09:29:59 -04:00
print_token.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
print.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
read_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
read.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
rotate_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
rotate.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
secrets_disable_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
secrets_disable.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
secrets_enable_test.go Adds ldap secrets to plugin registry and updates to v0.9.0 (#17152) 2022-09-15 22:19:24 -07:00
secrets_enable.go CLI: Tune plugin version for auth/secret mounts (#17277) 2022-09-22 20:55:46 +01:00
secrets_list_test.go Add deprecation status to auth/secrets list (#16849) 2022-08-31 16:11:14 -04:00
secrets_list.go CLI: Add version info to auth/secrets list -detailed (#17293) 2022-09-23 10:40:42 +01:00
secrets_move_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
secrets_move.go remount cli changes (#14159) 2022-02-18 08:50:05 -08:00
secrets_tune_test.go CLI: Tune plugin version for auth/secret mounts (#17277) 2022-09-22 20:55:46 +01:00
secrets_tune.go CLI: Tune plugin version for auth/secret mounts (#17277) 2022-09-22 20:55:46 +01:00
secrets.go Rename mounts to secrets engines and add the subcommand 2017-10-24 09:30:48 -04:00
server_noprofile.go Convert to Go 1.17 go:build directive (#13579) 2022-01-05 12:02:03 -06:00
server_profile.go Convert to Go 1.17 go:build directive (#13579) 2022-01-05 12:02:03 -06:00
server_test.go refactor: replace strings.Replace with strings.ReplaceAll (#15392) 2022-08-03 15:22:48 -04:00
server_util.go add OSS noop check for valid ent storage (#15894) 2022-06-08 17:15:28 -04:00
server.go HCP link integration (#16939) 2022-09-06 14:11:04 -04:00
ssh_test.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
ssh.go command: deprecate errwrap.Wrapf() (#11744) 2021-06-02 09:22:31 -04:00
status_test.go Fix bad rebase 2017-10-24 09:39:34 -04:00
status.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
token_capabilities_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
token_capabilities.go cleanup unused code and fix t.Fatal usage in goroutine in testing (#11694) 2021-09-30 07:33:14 -04:00
token_create_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
token_create.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
token_lookup_test.go CLI Enhancements (#3897) 2018-02-12 18:12:16 -05:00
token_lookup.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
token_renew_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
token_renew.go Update token renew docs (#12572) 2021-09-16 16:54:46 -07:00
token_revoke_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
token_revoke.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
token.go Add token as a subcommand 2017-10-24 09:30:47 -04:00
unwrap_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
unwrap.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
util.go dev docs: clarify internal and external token helpers (#13014) 2022-08-16 16:48:24 -04:00
version_history_test.go Vault CLI: show detailed information with ListResponseWithInfo (#15417) 2022-05-18 13:00:50 -04:00
version_history.go Add build date (#14957) 2022-04-19 14:28:08 -04:00
version_test.go Create sdk/ and api/ submodules (#6583) 2019-04-12 17:54:35 -04:00
version.go Run a more strict formatter over the code (#11312) 2021-04-08 09:43:39 -07:00
write_test.go Revert the WithContext changes to vault tests (#14947) 2022-04-07 15:12:58 -04:00
write.go add MFA validation support to vault login command (#14425) 2022-03-14 15:54:41 -04:00