diff options
Diffstat (limited to 'lib/chef/application/knife.rb')
| -rw-r--r-- | lib/chef/application/knife.rb | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/lib/chef/application/knife.rb b/lib/chef/application/knife.rb index bdf1b7e7a7..52d447891f 100644 --- a/lib/chef/application/knife.rb +++ b/lib/chef/application/knife.rb @@ -1,6 +1,6 @@ # # Author:: Adam Jacob (<adam@chef.io) -# Copyright:: Copyright 2009-2016, Chef Software Inc. +# Copyright:: Copyright 2009-2019, Chef Software Inc. # License:: Apache License, Version 2.0 # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -31,12 +31,12 @@ class Chef::Application::Knife < Chef::Application option :config_file, short: "-c CONFIG", long: "--config CONFIG", - description: "The configuration file to use", + description: "The configuration file to use.", proc: lambda { |path| File.expand_path(path, Dir.pwd) } option :config_option, long: "--config-option OPTION=VALUE", - description: "Override a single configuration option", + description: "Override a single configuration option.", proc: lambda { |option, existing| (existing ||= []) << option existing @@ -46,7 +46,7 @@ class Chef::Application::Knife < Chef::Application option :verbosity, short: "-V", long: "--verbose", - description: "More verbose output. Use twice for max verbosity", + description: "More verbose output. Use twice for max verbosity.", proc: Proc.new { verbosity_level += 1 }, default: 0 @@ -54,104 +54,104 @@ class Chef::Application::Knife < Chef::Application long: "--[no-]color", boolean: true, default: true, - description: "Use colored output, defaults to enabled" + description: "Use colored output, defaults to enabled." option :environment, short: "-E ENVIRONMENT", long: "--environment ENVIRONMENT", - description: "Set the #{Chef::Dist::PRODUCT} environment (except for in searches, where this will be flagrantly ignored)" + description: "Set the #{Chef::Dist::PRODUCT} environment (except for in searches, where this will be flagrantly ignored)." option :editor, short: "-e EDITOR", long: "--editor EDITOR", - description: "Set the editor to use for interactive commands", + description: "Set the editor to use for interactive commands.", default: ENV["EDITOR"] option :disable_editing, short: "-d", long: "--disable-editing", - description: "Do not open EDITOR, just accept the data as is", + description: "Do not open EDITOR, just accept the data as is.", boolean: true, default: false option :help, short: "-h", long: "--help", - description: "Show this message", + description: "Show this help message.", on: :tail, boolean: true option :node_name, short: "-u USER", long: "--user USER", - description: "API Client Username" + description: "#{Chef::Dist::SERVER_PRODUCT} API client username." option :client_key, short: "-k KEY", long: "--key KEY", - description: "API Client Key", + description: "#{Chef::Dist::SERVER_PRODUCT} API client key.", proc: lambda { |path| File.expand_path(path, Dir.pwd) } option :chef_server_url, short: "-s URL", long: "--server-url URL", - description: "#{Chef::Dist::PRODUCT} Server URL" + description: "#{Chef::Dist::SERVER_PRODUCT} URL." option :yes, short: "-y", long: "--yes", - description: "Say yes to all prompts for confirmation" + description: "Say yes to all prompts for confirmation." option :defaults, long: "--defaults", - description: "Accept default values for all questions" + description: "Accept default values for all questions." option :print_after, long: "--print-after", - description: "Show the data after a destructive operation" + description: "Show the data after a destructive operation." option :format, short: "-F FORMAT", long: "--format FORMAT", - description: "Which format to use for output", + description: "Which format to use for output.", default: "summary" option :local_mode, short: "-z", long: "--local-mode", - description: "Point knife commands at local repository instead of server", + description: "Point knife commands at local repository instead of #{Chef::Dist::SERVER_PRODUCT}.", boolean: true option :chef_zero_host, long: "--chef-zero-host HOST", - description: "Host to start chef-zero on" + description: "Host to start chef-zero on." option :chef_zero_port, long: "--chef-zero-port PORT", - description: "Port (or port range) to start chef-zero on. Port ranges like 1000,1010 or 8889-9999 will try all given ports until one works." + description: "Port (or port range) to start chef-zero on. Port ranges like 1000,1010 or 8889-9999 will try all given ports until one works." option :listen, long: "--[no-]listen", - description: "Whether a local mode (-z) server binds to a port", + description: "Whether a local mode (-z) server binds to a port.", boolean: false option :version, short: "-v", long: "--version", - description: "Show #{Chef::Dist::PRODUCT} version", + description: "Show #{Chef::Dist::PRODUCT} version.", boolean: true, proc: lambda { |v| puts "#{Chef::Dist::PRODUCT}: #{::Chef::VERSION}" }, exit: 0 option :fips, long: "--[no-]fips", - description: "Enable fips mode", + description: "Enable FIPS mode.", boolean: true, default: nil option :profile, long: "--profile PROFILE", - description: "The credentials profile to select" + description: "The credentials profile to select." # Run knife def run |