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
  "    Printing commands\n\n    Run commands with --help flag to see detailed usage and flags, e.g.:\n       abt track harvest -h\n\n    \#{commands_per_provider}\n  TXT\nend\n"

.examples ⇒ Object 



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

def examples
  "    Printing examples\n\n    \#{formatted_examples(Docs.basic_examples)}\n\n    \#{formatted_examples(Docs.extended_examples)}\n  TXT\nend\n"

.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
  "    Usage: \#{usage_line}\n\n    <command>   Name of command to execute, e.g. start, finalize etc.\n    <ARI>       A URI-like resource identifier with a scheme and an optional path\n                in the format: <scheme>[:<path>]. E.g., harvest:11111111/22222222\n    <options>   Optional flags for the command and ARI\n\n    \#{formatted_examples(Docs.basic_examples)}\n\n    For detailed examples/commands try:\n       abt examples\n       abt commands\n  TXT\nend\n"