usage-lib 6.0.0

Library for working with usage specs
Documentation 
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228

{%- if cmd.before_help %}{{ cmd.before_help }}

{% elif spec.before_help %}{{ spec.before_help }}

{% endif -%}
{%- if root %}
{%- if spec.name and spec.version %}{{ spec.name }} {{ spec.version }}
{% elif spec.version %}{{ spec.bin }} {{ spec.version }}
{% endif -%}
{%- if spec.about %}{{ spec.about }}

{% endif -%}
{%- else -%}
{%- if cmd.help %}{{ cmd.help }}

{% endif -%}
{%- endif -%}
{%- if cmd.deprecated or cmd.deprecated_warn_at or cmd.deprecated_remove_at %}
[deprecated:{% if cmd.deprecated %} {{ cmd.deprecated }}{% endif %}{% if cmd.deprecated_warn_at %}{% if cmd.deprecated %};{% endif %} warns at {{ cmd.deprecated_warn_at }}{% endif %}{% if cmd.deprecated_remove_at %}{% if cmd.deprecated or cmd.deprecated_warn_at %};{% endif %} removed at {{ cmd.deprecated_remove_at }}{% endif %}]

{%- endif -%}{{ mark_usage }}
{%- if cmd.flatten_help and cmd.flattened_usage %}
{%- for usage in cmd.flattened_usage %}
{% if loop.first %}Usage: {% else %}       {% endif %}{{ (spec.bin ~ " " ~ usage) | trim }}
{%- endfor %}
{%- else -%}
Usage: {{ (spec.bin ~ " " ~ cmd.usage) | trim }}
{%- endif %}{{ mark_commands }}

{%- if cmd.subcommands and not cmd.flatten_help %}
{%- set next_line_help = cmd.next_line_help %}
{%- for group in cmd.subcommand_groups %}

{{ group.heading | default(value=cmd.subcommand_help_heading | default(value="Commands")) }}:
{%- for cmd in group.items %}
  {{ cmd.usage | trim }}
{%- if cmd.deprecated or cmd.deprecated_warn_at or cmd.deprecated_remove_at %} [deprecated:{% if cmd.deprecated %} {{ cmd.deprecated }}{% endif %}{% if cmd.deprecated_warn_at %}{% if cmd.deprecated %};{% endif %} warns at {{ cmd.deprecated_warn_at }}{% endif %}{% if cmd.deprecated_remove_at %}{% if cmd.deprecated or cmd.deprecated_warn_at %};{% endif %} removed at {{ cmd.deprecated_remove_at }}{% endif %}]{%- endif %}
{%- if cmd.aliases %} [aliases: {{ cmd.aliases | join(sep=", ") }}]{% endif %}
{%- if cmd.help %}{% if next_line_help %}
    {{ cmd.help | indent(width=4) }}{% else %}  {{ cmd.help }}{% endif %}{%- endif %}
{%- endfor %}
{%- if not group.heading and show_help_subcommand %}
{% if next_line_help %}  help
    Print this message or the help of the given subcommand(s){% else %}  help  Print this message or the help of the given subcommand(s){% endif %}
{%- endif %}
{%- endfor %}
{%- endif %}{{ mark_args }}

{%- for group in cmd.arg_groups %}

{{ group.heading | default(value="Arguments") }}:
{%- for arg in group.items %}
  {% if arg.help %}{% if cmd.next_line_help %}{{ arg.usage | trim }}
    {{ arg.help | indent(width=4) }}{% else %}{{ arg.usage | trim | ljust(width=arg.usage_col_width) }}  {{ arg.help }}{% endif %}{% else %}{{ arg.usage | trim }}{% endif %}
{%- if cmd.next_line_help %}
{%- if not arg.hide_possible_values and arg.choices and arg.choices.choices %}
    [possible values: {{ arg.choices.choices | join(sep=", ") }}]{%- endif %}
{%- if not arg.hide_possible_values and arg.choices and arg.choices.env %}
    [choices env: {{ arg.choices.env }}]{%- endif %}
{%- if not arg.hide_env and arg.env %}
    [env: {{ arg.env }}]{%- endif %}
{%- if not arg.hide_env %}{% for env in arg.env_fallback %}
    [env fallback: {{ env }}]{%- endfor %}{% for env in arg.deprecated_env %}
    [deprecated env: {{ env }}]{%- endfor %}{%- endif %}
{%- if not arg.hide_default_value and arg.default %}
    (default: {{ arg.default | join(sep=", ") }}){%- endif %}
{%- else %}
{%- if not arg.hide_possible_values and arg.choices and arg.choices.choices %} [{{ arg.choices.choices | join(sep=", ") }}]{%- endif %}
{%- if not arg.hide_possible_values and arg.choices and arg.choices.env %} [choices env: {{ arg.choices.env }}]{%- endif %}
{%- if not arg.hide_env and arg.env %} [env: {{ arg.env }}]{%- endif %}
{%- if not arg.hide_env %}{% for env in arg.env_fallback %} [env fallback: {{ env }}]{%- endfor %}{% for env in arg.deprecated_env %} [deprecated env: {{ env }}]{%- endfor %}{%- endif %}
{%- if not arg.hide_default_value and arg.default %} (default: {{ arg.default | join(sep=", ") }}){%- endif %}
{%- endif %}
{%- endfor %}
{%- endfor %}{{ mark_flags }}

{%- for group in cmd.flag_groups %}

{{ group.heading | default(value="Flags") }}:
{%- for flag in group.items %}
  {% if flag.help %}{% if cmd.next_line_help %}{{ flag.display_usage }}{% if flag.aliases %}  [aliases: {{ flag.aliases | join(sep=", ") }}]{% endif %}
    {{ flag.help | indent(width=4) }}{% else %}{{ flag.display_usage | ljust(width=flag.usage_col_width) }}{% if flag.aliases %}  [aliases: {{ flag.aliases | join(sep=", ") }}]{% endif %}  {{ flag.help }}{% endif %}{% else %}{{ flag.display_usage }}{% if flag.aliases %}  [aliases: {{ flag.aliases | join(sep=", ") }}]{% endif %}{% endif %}
{%- if cmd.next_line_help %}
{%- if not flag.hide_possible_values and flag.arg.choices and flag.arg.choices.choices %}
    [possible values: {{ flag.arg.choices.choices | join(sep=", ") }}]{%- endif %}
{%- if not flag.hide_possible_values and flag.arg.choices and flag.arg.choices.env %}
    [choices env: {{ flag.arg.choices.env }}]{%- endif %}
{%- if not flag.hide_env and flag.env %}
    [env: {{ flag.env }}]{%- endif %}
{%- if not flag.hide_env %}{% for env in flag.env_fallback %}
    [env fallback: {{ env }}]{%- endfor %}{% for env in flag.deprecated_env %}
    [deprecated env: {{ env }}]{%- endfor %}{%- endif %}
{%- if not flag.hide_default_value and flag.default %}
    (default: {{ flag.default | join(sep=", ") }}){%- endif %}
{%- else %}
{%- if not flag.hide_possible_values and flag.arg.choices and flag.arg.choices.choices %} [{{ flag.arg.choices.choices | join(sep=", ") }}]{%- endif %}
{%- if not flag.hide_possible_values and flag.arg.choices and flag.arg.choices.env %} [choices env: {{ flag.arg.choices.env }}]{%- endif %}
{%- if not flag.hide_env and flag.env %} [env: {{ flag.env }}]{%- endif %}
{%- if not flag.hide_env %}{% for env in flag.env_fallback %} [env fallback: {{ env }}]{%- endfor %}{% for env in flag.deprecated_env %} [deprecated env: {{ env }}]{%- endfor %}{%- endif %}
{%- if not flag.hide_default_value and flag.default %} (default: {{ flag.default | join(sep=", ") }}){%- endif %}
{%- endif %}
{%- if flag.deprecated or flag.deprecated_warn_at or flag.deprecated_remove_at %}{% if cmd.next_line_help %}
    {% else %} {% endif %}[deprecated:{% if flag.deprecated %} {{ flag.deprecated }}{% endif %}{% if flag.deprecated_warn_at %}{% if flag.deprecated %};{% endif %} warns at {{ flag.deprecated_warn_at }}{% endif %}{% if flag.deprecated_remove_at %}{% if flag.deprecated or flag.deprecated_warn_at %};{% endif %} removed at {{ flag.deprecated_remove_at }}{% endif %}]{%- endif %}
{%- endfor %}
{%- endfor %}

{%- if global_flags %}

Global flags:
{%- for flag in global_flags %}
  {% if flag.help %}{% if cmd.next_line_help %}{{ flag.display_usage }}{% if flag.aliases %}  [aliases: {{ flag.aliases | join(sep=", ") }}]{% endif %}
    {{ flag.help | indent(width=4) }}{% else %}{{ flag.display_usage | ljust(width=flag.usage_col_width) }}{% if flag.aliases %}  [aliases: {{ flag.aliases | join(sep=", ") }}]{% endif %}  {{ flag.help }}{% endif %}{% else %}{{ flag.display_usage }}{% if flag.aliases %}  [aliases: {{ flag.aliases | join(sep=", ") }}]{% endif %}{% endif %}
{%- if cmd.next_line_help %}
{%- if not flag.hide_possible_values and flag.arg.choices and flag.arg.choices.choices %}
    [possible values: {{ flag.arg.choices.choices | join(sep=", ") }}]{%- endif %}
{%- if not flag.hide_possible_values and flag.arg.choices and flag.arg.choices.env %}
    [choices env: {{ flag.arg.choices.env }}]{%- endif %}
{%- if not flag.hide_env and flag.env %}
    [env: {{ flag.env }}]{%- endif %}
{%- if not flag.hide_env %}{% for env in flag.env_fallback %}
    [env fallback: {{ env }}]{%- endfor %}{% for env in flag.deprecated_env %}
    [deprecated env: {{ env }}]{%- endfor %}{%- endif %}
{%- if not flag.hide_default_value and flag.default %}
    (default: {{ flag.default | join(sep=", ") }}){%- endif %}
{%- else %}
{%- if not flag.hide_possible_values and flag.arg.choices and flag.arg.choices.choices %} [{{ flag.arg.choices.choices | join(sep=", ") }}]{%- endif %}
{%- if not flag.hide_possible_values and flag.arg.choices and flag.arg.choices.env %} [choices env: {{ flag.arg.choices.env }}]{%- endif %}
{%- if not flag.hide_env and flag.env %} [env: {{ flag.env }}]{%- endif %}
{%- if not flag.hide_env %}{% for env in flag.env_fallback %} [env fallback: {{ env }}]{%- endfor %}{% for env in flag.deprecated_env %} [deprecated env: {{ env }}]{%- endfor %}{%- endif %}
{%- if not flag.hide_default_value and flag.default %} (default: {{ flag.default | join(sep=", ") }}){%- endif %}
{%- endif %}
{%- if flag.deprecated or flag.deprecated_warn_at or flag.deprecated_remove_at %}{% if cmd.next_line_help %}
    {% else %} {% endif %}[deprecated:{% if flag.deprecated %} {{ flag.deprecated }}{% endif %}{% if flag.deprecated_warn_at %}{% if flag.deprecated %};{% endif %} warns at {{ flag.deprecated_warn_at }}{% endif %}{% if flag.deprecated_remove_at %}{% if flag.deprecated or flag.deprecated_warn_at %};{% endif %} removed at {{ flag.deprecated_remove_at }}{% endif %}]{%- endif %}
{%- endfor %}
{%- endif %}{{ mark_flattened }}

{%- if cmd.flatten_help %}
{%- for sub in cmd.flattened_subcommands %}

{{ sub.full_cmd | join(sep=" ") }}:
{%- if sub.help %}
{{ sub.help | trim }}
{%- endif %}
{%- if sub.deprecated or sub.deprecated_warn_at or sub.deprecated_remove_at %}
[deprecated:{% if sub.deprecated %} {{ sub.deprecated }}{% endif %}{% if sub.deprecated_warn_at %}{% if sub.deprecated %};{% endif %} warns at {{ sub.deprecated_warn_at }}{% endif %}{% if sub.deprecated_remove_at %}{% if sub.deprecated or sub.deprecated_warn_at %};{% endif %} removed at {{ sub.deprecated_remove_at }}{% endif %}]
{%- endif %}
{%- for group in sub.arg_groups %}
{%- for arg in group.items %}
  {% if arg.help %}{% if sub.flattened_next_line_help %}{{ arg.usage | trim }}
    {{ arg.help | indent(width=4) }}{% else %}{{ arg.usage | trim | ljust(width=arg.usage_col_width) }}  {{ arg.help }}{% endif %}{% else %}{{ arg.usage | trim }}{% endif %}
{%- if sub.flattened_next_line_help %}
{%- if not arg.hide_possible_values and arg.choices and arg.choices.choices %}
    [possible values: {{ arg.choices.choices | join(sep=", ") }}]{%- endif %}
{%- if not arg.hide_possible_values and arg.choices and arg.choices.env %}
    [choices env: {{ arg.choices.env }}]{%- endif %}
{%- if not arg.hide_env and arg.env %}
    [env: {{ arg.env }}]{%- endif %}
{%- if not arg.hide_env %}{% for env in arg.env_fallback %}
    [env fallback: {{ env }}]{%- endfor %}{% for env in arg.deprecated_env %}
    [deprecated env: {{ env }}]{%- endfor %}{%- endif %}
{%- if not arg.hide_default_value and arg.default %}
    (default: {{ arg.default | join(sep=", ") }}){%- endif %}
{%- else %}
{%- if not arg.hide_possible_values and arg.choices and arg.choices.choices %} [{{ arg.choices.choices | join(sep=", ") }}]{%- endif %}
{%- if not arg.hide_possible_values and arg.choices and arg.choices.env %} [choices env: {{ arg.choices.env }}]{%- endif %}
{%- if not arg.hide_env and arg.env %} [env: {{ arg.env }}]{%- endif %}
{%- if not arg.hide_env %}{% for env in arg.env_fallback %} [env fallback: {{ env }}]{%- endfor %}{% for env in arg.deprecated_env %} [deprecated env: {{ env }}]{%- endfor %}{%- endif %}
{%- if not arg.hide_default_value and arg.default %} (default: {{ arg.default | join(sep=", ") }}){%- endif %}
{%- endif %}
{%- endfor %}
{%- endfor %}
{%- for group in sub.flag_groups %}
{%- for flag in group.items %}
  {% if flag.help %}{% if sub.flattened_next_line_help %}{{ flag.display_usage }}
    {{ flag.help | indent(width=4) }}{% else %}{{ flag.display_usage | ljust(width=flag.usage_col_width) }}  {{ flag.help }}{% endif %}{% else %}{{ flag.display_usage }}{% endif %}
{%- if sub.flattened_next_line_help %}
{%- if not flag.hide_possible_values and flag.arg.choices and flag.arg.choices.choices %}
    [possible values: {{ flag.arg.choices.choices | join(sep=", ") }}]{%- endif %}
{%- if not flag.hide_possible_values and flag.arg.choices and flag.arg.choices.env %}
    [choices env: {{ flag.arg.choices.env }}]{%- endif %}
{%- if not flag.hide_env and flag.env %}
    [env: {{ flag.env }}]{%- endif %}
{%- if not flag.hide_env %}{% for env in flag.env_fallback %}
    [env fallback: {{ env }}]{%- endfor %}{% for env in flag.deprecated_env %}
    [deprecated env: {{ env }}]{%- endfor %}{%- endif %}
{%- if not flag.hide_default_value and flag.default %}
    (default: {{ flag.default | join(sep=", ") }}){%- endif %}
{%- else %}
{%- if not flag.hide_possible_values and flag.arg.choices and flag.arg.choices.choices %} [{{ flag.arg.choices.choices | join(sep=", ") }}]{%- endif %}
{%- if not flag.hide_possible_values and flag.arg.choices and flag.arg.choices.env %} [choices env: {{ flag.arg.choices.env }}]{%- endif %}
{%- if not flag.hide_env and flag.env %} [env: {{ flag.env }}]{%- endif %}
{%- if not flag.hide_env %}{% for env in flag.env_fallback %} [env fallback: {{ env }}]{%- endfor %}{% for env in flag.deprecated_env %} [deprecated env: {{ env }}]{%- endfor %}{%- endif %}
{%- if not flag.hide_default_value and flag.default %} (default: {{ flag.default | join(sep=", ") }}){%- endif %}
{%- endif %}
{%- if flag.deprecated or flag.deprecated_warn_at or flag.deprecated_remove_at %}{% if sub.flattened_next_line_help %}
    {% else %} {% endif %}[deprecated:{% if flag.deprecated %} {{ flag.deprecated }}{% endif %}{% if flag.deprecated_warn_at %}{% if flag.deprecated %};{% endif %} warns at {{ flag.deprecated_warn_at }}{% endif %}{% if flag.deprecated_remove_at %}{% if flag.deprecated or flag.deprecated_warn_at %};{% endif %} removed at {{ flag.deprecated_remove_at }}{% endif %}]{%- endif %}
{%- endfor %}
{%- endfor %}
{%- endfor %}
{%- endif %}{{ mark_after_help }}

{%- if cmd.examples %}

Examples:
{%- for example in cmd.examples %}
{%- if example.header %}
  {{ example.header }}:
{%- endif %}
    $ {{ example.code }}
{%- endfor %}
{%- elif spec.examples %}

Examples:
{%- for example in spec.examples %}
{%- if example.header %}
  {{ example.header }}:
{%- endif %}
    $ {{ example.code }}
{%- endfor %}
{%- endif %}

{%- if cmd.after_help %}

{{ cmd.after_help }}
{%- elif spec.after_help %}

{{ spec.after_help }}
{%- endif -%}