diff options
author | Daniil Fedotov <hairyhum@gmail.com> | 2019-02-11 14:07:34 -0500 |
---|---|---|
committer | Daniil Fedotov <hairyhum@gmail.com> | 2019-02-11 14:07:34 -0500 |
commit | 680c8969ca5f6f80548bdfb2ce5d67db701f92ec (patch) | |
tree | b59265784f89e84bff98343148dca9161aa06181 /deps/rabbitmq_cli | |
parent | 5fabaeddb4774b378b4cc55e3284dcde02e424da (diff) | |
download | rabbitmq-server-git-680c8969ca5f6f80548bdfb2ce5d67db701f92ec.tar.gz |
Add more command descriptions
Diffstat (limited to 'deps/rabbitmq_cli')
20 files changed, 46 insertions, 13 deletions
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/delete_queue_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/delete_queue_command.ex index 403b6632d2..9c5c095d7f 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/delete_queue_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/delete_queue_command.ex @@ -23,6 +23,8 @@ defmodule RabbitMQ.CLI.Ctl.Commands.DeleteQueueCommand do def help_section(), do: :queues + def description(), do: "Deletes a queue" + def banner([qname], %{vhost: vhost, if_empty: if_empty, if_unused: if_unused}) do if_empty_str = case if_empty do diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/delete_vhost_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/delete_vhost_command.ex index 87c8ead10d..c1b039aab8 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/delete_vhost_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/delete_vhost_command.ex @@ -30,6 +30,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.DeleteVhostCommand do def usage, do: "delete_vhost <vhost>" def help_section(), do: :vhost + def description(), do: "Deletes a virtual host" def banner([arg], _), do: "Deleting vhost \"#{arg}\" ..." end diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/environment_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/environment_command.ex index 91d9a158c0..474d605a42 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/environment_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/environment_command.ex @@ -33,5 +33,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.EnvironmentCommand do def help_section(), do: :report + def description(), do: "Displays the name and value of each variable in the application environment for each running application" + def banner(_, %{node: node_name}), do: "Application environment of node #{node_name} ..." end diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/eval_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/eval_command.ex index 3d2b51bc5b..9a044ec177 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/eval_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/eval_command.ex @@ -49,6 +49,8 @@ defmodule RabbitMQ.CLI.Ctl.Commands.EvalCommand do def usage, do: "eval <expr>" + def description(), do: "Executes Erlang code on the RabbitMQ node" + def banner(_, _), do: nil # diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/exec_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/exec_command.ex index fd744eaeca..6c9b483812 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/exec_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/exec_command.ex @@ -64,5 +64,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ExecCommand do def usage, do: "exec <expr> [--offline]" + def description(), do: "Executes Elixir code on the CLI node" + def banner(_, _), do: nil end diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_bindings_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_bindings_command.ex index 9278a3a071..44af402f2f 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_bindings_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_bindings_command.ex @@ -71,6 +71,8 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ListBindingsCommand do def help_section(), do: :list + def description(), do: "Lists all bindings on a vhost" + def usage_additional() do "<bindinginfoitem> must be a member of the list [" <> Enum.join(@info_keys, ", ") <> "]." diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_channels_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_channels_command.ex index 27302dec7f..f548ba2a94 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_channels_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_channels_command.ex @@ -76,6 +76,8 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ListChannelsCommand do def help_section(), do: :list + def description(), do: "Lists all channels in the node" + def usage_additional() do "<channelinfoitem> must be a member of the list [" <> Enum.join(@info_keys, ", ") <> "]." diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_connections_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_connections_command.ex index cdc897e4e6..f7dd63e3d1 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_connections_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_connections_command.ex @@ -75,6 +75,8 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ListConnectionsCommand do def help_section(), do: :list + def description(), do: "Lists AMQP connections for the node" + def usage_additional() do "<connectioninfoitem> must be a member of the list [" <> Enum.join(@info_keys, ", ") <> "]." diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_consumers_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_consumers_command.ex index f1bdd17148..612f34ba9a 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_consumers_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_consumers_command.ex @@ -73,6 +73,8 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ListConsumersCommand do def help_section(), do: :list + def description(), do: "Lists all consumers for a vhost" + def usage_additional() do "<consumerinfoitem> must be a member of the list [" <> Enum.join(@info_keys, ", ") <> "]." end diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_exchanges_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_exchanges_command.ex index 6fcdd75868..b17758eaec 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_exchanges_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_exchanges_command.ex @@ -22,10 +22,18 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ListExchangesCommand do def info_keys(), do: @info_keys + def description(), do: "Lists exchanges" + def usage(), do: "list_exchanges [-p <vhost>] [--no-table-headers] [<exchangeinfoitem> ...]" def scopes(), do: [:ctl, :diagnostics] use RabbitMQ.CLI.Core.AcceptsDefaultSwitchesAndTimeout + def help_section(), do: :list + def formatter(), do: RabbitMQ.CLI.Formatters.Table + def usage_additional(), do: "<exchangeinfoitem> must be a member of the list [" <> Enum.join(@info_keys, ", ") <> "]." + + + def merge_defaults([], opts) do merge_defaults(~w(name type), opts) end @@ -58,18 +66,5 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ListExchangesCommand do use RabbitMQ.CLI.DefaultOutput - def formatter(), do: RabbitMQ.CLI.Formatters.Table - - def usage() do - "list_exchanges [-p <vhost>] [--no-table-headers] [<exchangeinfoitem> ...]" - end - - def help_section(), do: :list - - def usage_additional() do - "<exchangeinfoitem> must be a member of the list [" <> - Enum.join(@info_keys, ", ") <> "]." - end - def banner(_, %{vhost: vhost}), do: "Listing exchanges for vhost #{vhost} ..." end diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_unresponsive_queues_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_unresponsive_queues_command.ex index aa60aad4df..1033348c82 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_unresponsive_queues_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_unresponsive_queues_command.ex @@ -90,6 +90,8 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ListUnresponsiveQueuesCommand do def help_section(), do: :list + def description(), do: "Tests queues to respond within timeout. Lists those which did not respond" + def usage_additional() do "<unresponsive_queueinfoitem> must be a member of the list [" <> Enum.join(@info_keys, ", ") <> "]." diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_users_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_users_command.ex index be8e2044b0..bdf8d83715 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_users_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_users_command.ex @@ -37,5 +37,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ListUsersCommand do def usage, do: "list_users [--no-table-headers]" def help_section(), do: :user_management + def description(), do: "List user names and tags" + def banner(_, _), do: "Listing users ..." end diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_vhosts_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_vhosts_command.ex index 9ee94842cb..8345d1af33 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_vhosts_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/list_vhosts_command.ex @@ -53,6 +53,8 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ListVhostsCommand do def usage, do: "list_vhosts [--no-table-headers] [<vhostinfoitem> ...]" def help_section(), do: :vhost + def description(), do: "Lists virtual hosts" + def usage_additional() do "<vhostinfoitem> must be a member of the list [name, tracing, cluster_state]." end diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/node_health_check_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/node_health_check_command.ex index c44672f8ae..87e526b3f7 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/node_health_check_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/node_health_check_command.ex @@ -70,6 +70,9 @@ defmodule RabbitMQ.CLI.Ctl.Commands.NodeHealthCheckCommand do def usage, do: "node_health_check" + def help_section(), do: :report + def description(), do: "Run a generic health check on the node" + def banner(_, %{node: node_name, timeout: timeout}) do ["Timeout: #{trunc(timeout / 1000)} seconds ...", "Checking health of node #{node_name} ..."] end diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/quorum_status_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/quorum_status_command.ex index 62858a3d5f..74439603c2 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/quorum_status_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/quorum_status_command.ex @@ -42,6 +42,8 @@ defmodule RabbitMQ.CLI.Ctl.Commands.QuorumStatusCommand do def help_section(), do: :queues + def description(), do: "Displays quorum status of a quorum queue" + def banner([name], %{node: node_name}), do: "Status of quorum queue #{name} on node #{node_name} ..." end diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/report_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/report_command.ex index 6cf160a1d1..17245e1ae4 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/report_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/report_command.ex @@ -91,6 +91,8 @@ defmodule RabbitMQ.CLI.Ctl.Commands.ReportCommand do def help_section(), do: :report + def description(), do: "Generate a server status report containing a concatenation of all server status information for support purposes" + def banner(_, %{node: node_name}), do: "Reporting server status of node #{node_name} ..." # diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/restart_vhost_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/restart_vhost_command.ex index 408d0ef888..02bd965889 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/restart_vhost_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/restart_vhost_command.ex @@ -32,6 +32,8 @@ defmodule RabbitMQ.CLI.Ctl.Commands.RestartVhostCommand do def usage, do: "restart_vhost [-p <vhost>]" def help_section(), do: :vhost + def description(), do: "Restarts a failed vhost data storage and queues" + def banner(_, %{node: node_name, vhost: vhost}) do "Trying to restart vhost '#{vhost}' on node '#{node_name}' ..." end diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/set_log_level_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/set_log_level_command.ex index bb904ad2e7..e96cbe34b8 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/set_log_level_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/set_log_level_command.ex @@ -57,6 +57,8 @@ defmodule RabbitMQ.CLI.Ctl.Commands.SetLogLevelCommand do def help_section(), do: :settings + def description(), do: "Sets log level in the running node" + def banner([log_level], _), do: "Setting log level to \"#{log_level}\" ..." def output({:error, {:invalid_log_level, level}}, _opts) do diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/set_user_tags_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/set_user_tags_command.ex index 082655ea5f..b84d376573 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/set_user_tags_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/set_user_tags_command.ex @@ -42,6 +42,8 @@ defmodule RabbitMQ.CLI.Ctl.Commands.SetUserTagsCommand do def help_section(), do: :user_management + def description(), do: "Sets user tags" + def banner([user | tags], _) do "Setting tags for user \"#{user}\" to [#{tags |> Enum.join(", ")}] ..." end diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/status_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/status_command.ex index f70353d30e..d4037438d4 100644 --- a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/status_command.ex +++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/status_command.ex @@ -33,5 +33,7 @@ defmodule RabbitMQ.CLI.Ctl.Commands.StatusCommand do def help_section(), do: :report + def description(), do: "Displays broker status information" + def banner(_, %{node: node_name}), do: "Status of node #{node_name} ..." end |