Module: D3::Client::Help

Extended by:
Help
Included in:
Help
Defined in:
lib/d3/client/help.rb

Constant Summary collapse

USAGE = 
"Usage: d3 action [target [...]] [options]\nUse -H for help"

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.help_text ⇒ String

Return the d3amin help text

Its far easier and more flexible to maintain the visual layout of this complex help as a single large heredoc, than it is to build it programmatically from the commands and options hashes The downside is that it must be manually updated when those hashes change.

Returns:

  • (String) —

    the d3 help text



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
102
103
104
105
106
107
 
# File 'lib/d3/client/help.rb', line 44

def help_text
  helptxt = <<-ENDHELP

d3: package/patch management & deployment tool to enhance the package-
handling capabilities of Jamf Pro.

#{USAGE}

All actions have a 1-2 character shortcut.

For details see https://github.com/PixarAnimationStudios/depot3/wiki/Client

Actions:
  install   i  <basename/edition>       - Install packages or queue for logout
  uninstall u  <basename>               - Uninstall packages
  freeze    f  <basename>               - Stop auto-updates of this basename
  thaw      t  <basename>               - Resume auto-updates of this basename
  forget    fg <basename>               - Remove receipt without uninstalling
  dequeue   dq <basename>               - Remove a pending logout install
  sync      s                           - Update receipt data, do auto-installs
                                    update installed software & uninstall
                                    expired receipts
  help                                  - Show this help summary

List Actions:
  list-available  la                    - Live pkgs available to this computer
  list-installed  li                    - Receipts on this computer
  list-manual     lm                    - Manually installed receipts
  list-pilots     lp                    - Pilot receipts on this computer
  list-frozen     lf                    - Frozen receipts on this computer
  list-queue      lq                    - Pending puppy (logout) installs
  list-details    ld <basename/edition> - Package & receipt details
  list-files      ls <basename/edition> - Files installed by the package
  query-file      qf <path>             - Which packages install <path>?

Options:
  -q, --quiet                  - Be as silent as possible,
                           use twice for more silence
  -v, --verbose                - Give more detail about what's happening,
                           use twice for more details
  -p, --puppies                - Do puppy installs now, instead of queuing
                           When used with 'install', the pkgs
                           pkgs are installed immediately
                           When used with 'sync' any queued puppies
                           are installed immediately
  -f, --force                  - Force d3 to perform unnatural acts
  -a, --admin <admin>          - The name of the admin using d3
  -N, --no-puppy-notification  - Don't run the puppy-notification policy
  -e, --expiration <days>      - With 'install', set a custom expiration
                           if the pkg is expirable
  -F, --freeze                 - With 'install', freeze receipt immediately
  -d, --debug                  - Set verbosity and logging to full blast
  -V, --version                - Show d3 version info
  -H, --help                   - Show this help info


Notes
 - All <targets> can be a list of several, space-separated
 - When a basename is given as a target for install, list-details, or
   list-files, the currently live edition is used.

ENDHELP
  helptxt
end

Instance Method Details

#help_text ⇒ String

Return the d3amin help text

Its far easier and more flexible to maintain the visual layout of this complex help as a single large heredoc, than it is to build it programmatically from the commands and options hashes The downside is that it must be manually updated when those hashes change.

Returns:

  • (String) —

    the d3 help text



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
102
103
104
105
106
107
 
# File 'lib/d3/client/help.rb', line 44

def help_text
  helptxt = <<-ENDHELP

d3: package/patch management & deployment tool to enhance the package-
handling capabilities of Jamf Pro.

#{USAGE}

All actions have a 1-2 character shortcut.

For details see https://github.com/PixarAnimationStudios/depot3/wiki/Client

Actions:
  install   i  <basename/edition>       - Install packages or queue for logout
  uninstall u  <basename>               - Uninstall packages
  freeze    f  <basename>               - Stop auto-updates of this basename
  thaw      t  <basename>               - Resume auto-updates of this basename
  forget    fg <basename>               - Remove receipt without uninstalling
  dequeue   dq <basename>               - Remove a pending logout install
  sync      s                           - Update receipt data, do auto-installs
                                    update installed software & uninstall
                                    expired receipts
  help                                  - Show this help summary

List Actions:
  list-available  la                    - Live pkgs available to this computer
  list-installed  li                    - Receipts on this computer
  list-manual     lm                    - Manually installed receipts
  list-pilots     lp                    - Pilot receipts on this computer
  list-frozen     lf                    - Frozen receipts on this computer
  list-queue      lq                    - Pending puppy (logout) installs
  list-details    ld <basename/edition> - Package & receipt details
  list-files      ls <basename/edition> - Files installed by the package
  query-file      qf <path>             - Which packages install <path>?

Options:
  -q, --quiet                  - Be as silent as possible,
                           use twice for more silence
  -v, --verbose                - Give more detail about what's happening,
                           use twice for more details
  -p, --puppies                - Do puppy installs now, instead of queuing
                           When used with 'install', the pkgs
                           pkgs are installed immediately
                           When used with 'sync' any queued puppies
                           are installed immediately
  -f, --force                  - Force d3 to perform unnatural acts
  -a, --admin <admin>          - The name of the admin using d3
  -N, --no-puppy-notification  - Don't run the puppy-notification policy
  -e, --expiration <days>      - With 'install', set a custom expiration
                           if the pkg is expirable
  -F, --freeze                 - With 'install', freeze receipt immediately
  -d, --debug                  - Set verbosity and logging to full blast
  -V, --version                - Show d3 version info
  -H, --help                   - Show this help info


Notes
 - All <targets> can be a list of several, space-separated
 - When a basename is given as a target for install, list-details, or
   list-files, the currently live edition is used.

ENDHELP
  helptxt
end