summaryrefslogtreecommitdiff
path: root/lib/leap_cli/commands/README
blob: 00fcd841aa5358ac998c2caea870dbdc61e9f6c5 (plain)
1
2
3
4
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
This directory contains ruby source files that define the available sub-commands of the `leap` executable.

For example, the command:

  leap init <directory>

Lives in lib/leap_cli/commands/init.rb

These files use a DSL (called GLI) for defining command suites.
See https://github.com/davetron5000/gli for more information.


      c.command
      c.commands
      c.default_command
      c.default_value
      c.get_default_command
      c.commands
      c.commands_declaration_order

      c.flag
      c.flags
      c.switch
      c.switches

      c.long_desc

      c.default_desc
      c.default_description
      c.desc
      c.description
      c.long_description
      c.context_description
      c.usage

      c.arg_name
      c.arguments_description
      c.arguments_options

      c.skips_post
      c.skips_pre
      c.skips_around

      c.action

      c.copy_options_to_aliases
      c.nodoc
      c.aliases
      c.execute
      c.names


#desc 'Describe some switch here'
#switch [:s,:switch]

#desc 'Describe some flag here'
#default_value 'the default'
#arg_name 'The name of the argument'
#flag [:f,:flagname]

# desc 'Describe deploy here'
# arg_name 'Describe arguments to deploy here'
# command :deploy do |c|
#   c.action do |global_options,options,args|
#     puts "deploy command ran"
#   end
# end

# desc 'Describe dryrun here'
# arg_name 'Describe arguments to dryrun here'
# command :dryrun do |c|
#   c.action do |global_options,options,args|
#     puts "dryrun command ran"
#   end
# end

# desc 'Describe add-node here'
# arg_name 'Describe arguments to add-node here'
# command :"add-node" do |c|
#   c.desc 'Describe a switch to init'
#   c.switch :s
#
#   c.desc 'Describe a flag to init'
#   c.default_value 'default'
#   c.flag :f
#   c.action do |global_options,options,args|
#     puts "add-node command ran"
#   end
# end

# post do |global,command,options,args|
#   # Post logic here
#   # Use skips_post before a command to skip this
#   # block on that command only
# end

# on_error do |exception|
#   # Error logic here
#   # return false to skip default error handling
#   true
# end