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

{%- if flag.effect %}

**Effect**: {% if flag.effect == "read" %}read-only{% elif flag.effect == "destructive" %}destructive — may delete or irreversibly overwrite{% else %}modifies state{% endif %}
{%- endif %}
{%- if flag.deprecated or flag.deprecated_warn_at or flag.deprecated_remove_at %}

**Deprecated:**{% if flag.deprecated %} {{ flag.deprecated }}{% if flag.deprecated_warn_at or flag.deprecated_remove_at %};{% endif %}{% endif %}{% if flag.deprecated_warn_at %} Warns at {{ flag.deprecated_warn_at }}.{% endif %}{% if flag.deprecated_remove_at %} Removed at {{ flag.deprecated_remove_at }}.{% endif %}
{%- endif %}
{%- if flag.help_md %}

{{ flag.help_md | escape_md }}
{%- endif %}
{%- if flag.arg.choices and flag.arg.choices.choices %}

**Choices:**
{% for choice in flag.arg.choices.choices %}
- `{{ choice }}`
{%- endfor %}
{%- endif %}
{%- if flag.arg.choices and flag.arg.choices.env %}

**Choices Environment Variable:** `{{ flag.arg.choices.env }}`
{%- endif %}
{%- if flag.default | length > 0 %}

**Default:** {% for d in flag.default %}`{{ d }}`{% if not loop.last %}, {% endif %}{% endfor %}
{%- endif %}
{%- if flag.env %}

**Environment Variable:** `{{ flag.env }}`
{%- endif -%}
{%- if flag.env_fallback | length > 0 %}

**Environment Fallbacks:** {% for env in flag.env_fallback %}`{{ env }}`{% if not loop.last %}, {% endif %}{% endfor %}
{%- endif -%}
{%- if flag.deprecated_env | length > 0 %}

**Deprecated Environment Variables:** {% for env in flag.deprecated_env %}`{{ env }}`{% if not loop.last %}, {% endif %}{% endfor %}
{%- endif -%}