Class: Beats::Command::Help

Inherits:
Base
  • Object
show all
Defined in:
lib/beats/commands/help.rb

Defined Under Namespace

Classes: CommandGroup

Instance Attribute Summary

Attributes inherited from Base

#args

Instance Method Summary collapse

Methods inherited from Base

has_command?, #initialize

Constructor Details

This class inherits a constructor from Beats::Command::Base

Instance Method Details

#help ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/beats/commands/help.rb', line 5

def help
  display 'Usage: beats COMMAND [command-specific-options]'
  space
  command_group('Help commands (type "beats help COMMAND" for more details):') do
    command 'help', 'show this help text'
    command 'version', 'show version information'
  end
  command_group('General commands:') do
    command 'info', 'show detailed service info'
    command 'show', 'fetch and show a resource'
    command 'search', 'search in the music catalogue'
  end
  command_group('Account commands:') do
    command 'auth:login', 'authenticate with your account credentials'
    command 'auth:logout', 'clear saved credentials'
    command 'account', 'show account info for current user'
    command 'account:history', 'add something to a users history'
  end
  command_group('The sentence:') do
    command 'sentence', 'show the sentence'
  end
  command_group('Ingest commands:') do
    command 'ingest:<adapter>', 'ingest using an adapter plugin, e.g. ingest:discogs'
  end
end