Class: Turbot::Command::Help
Overview
List commands and display help
Constant Summary collapse
- PRIMARY_NAMESPACES =
Set.new(%w(auth bots))
Constants included from Helpers
Instance Method Summary collapse
-
#index ⇒ Object
help [COMMAND].
Methods included from Helpers
#api, #ask, #ask_for_password, #ask_for_password_on_windows, #delete_netrc_entry, #email_address_and_api_key, #error, #format_error, #host, #netrc_exists?, #netrc_path, #open_netrc, #save_netrc_entry, #styled_error, #turbot_api, #turbot_api_parameters
Constructor Details
This class inherits a constructor from Turbot::Command::Base
Instance Method Details
#index ⇒ Object
help [COMMAND]
List available commands or display help for a specific command.
Examples:
$ turbot help Usage: turbot COMMAND [--bot APP] [command-specific-options]
Primary help topics, type "turbot help TOPIC" for more details:
auth # Login or logout from Turbot bots # Manage bots (generate skeleton, validate data, submit code)
Additional topics:
help # List commands and display help version # Display version
$ turbot help auth:whoam Usage: turbot auth:whoami
Display your Turbot email address.
Example:
$ turbot auth:whoami [email protected]
35 36 37 38 39 40 41 42 |
# File 'lib/turbot/command/help.rb', line 35 def index command = args.shift if command help_for_command(command) else help_for_root end end |