Module: Abt::Docs::Cli

Defined in:
lib/abt/docs/cli.rb

Class Method Summary collapse

Class Method Details

.commands ⇒ Object 



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/abt/docs/cli.rb', line 34

def commands
  <<~TXT
    Printing commands

    Run commands with --help flag to see detailed usage and flags, e.g.:
       abt track harvest -h

    #{commands_per_provider}
  TXT
end

.examples ⇒ Object 



24
25
26
27
28
29
30
31
32
 
# File 'lib/abt/docs/cli.rb', line 24

def examples
  <<~TXT
    Printing examples

    #{formatted_examples(Docs.basic_examples)}

    #{formatted_examples(Docs.extended_examples)}
  TXT
end

.help ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/abt/docs/cli.rb', line 7

def help
  <<~TXT
    Usage: #{usage_line}

    <command>   Name of command to execute, e.g. start, finalize etc.
    <ARI>       A URI-like resource identifier with a scheme and an optional path
                in the format: <scheme>[:<path>]. E.g., harvest:11111111/22222222
    <options>   Optional flags for the command and ARI

    #{formatted_examples(Docs.basic_examples)}

    For detailed examples/commands try:
       abt examples
       abt commands
  TXT
end