<commit_before>---
title: App helpers
template: docs
taxonomy:
    category: docs
routes:
  default: '/packaging_apps_helpers'
---

Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/{{ current_commit }}/doc/generate_helper_doc.py) on {{data.date}} (Yunohost version {{data.version}})

{% for category, helpers in data.helpers %}
### {{ category.upper() }}
{% for h in helpers %}
**{{ h.name }}**  
[details summary="<i>{{ h.brief }}</i>" class="helper-card-subtitle text-muted"]
<p></p>

**Usage**: `{{ h.usage }}`
    {% if h.args %}

**Arguments**:  
        {% for infos in h.args %}
            {% if infos|length == 2 %}
- `{{ infos[0] }}`: {{ infos[1] }}
            {% else %}
- `{{ infos[0] }}`, `{{ infos[1] }}`: {{ infos[2] }}
            {% endif %}
        {% endfor %}
    {% endif %}
    {% if h.ret %}

**Returns**: {{ h.ret }}
    {% endif %}
    {% if "example" in h.keys() %}
**Example**: `{{ h.example }}`
    {% endif %}
    {% if "examples" in h.keys() %}

**Examples**:  
        {% for example in h.examples %}
            {% if not example.strip().startswith("# ") %}
- `{{ example }}`
            {% else %}
- `{{ example.strip("# ") }}`
            {% endif %}
        {% endfor %}
    {% endif %}
    {% if h.details %}

**Details**:  
{{ h.details.replace('\n', '</br>').replace('_', '\_') }}
    {% endif %}

[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/{{ current_commit }}/data/helpers.d/{{ category }}#L{{ h.line + 1 }})
[/details]
----------------
{% endfor %}
{% endfor %}<commit_msg>Enhance the jinja template for bash helpers<commit_after>---
title: App helpers
template: docs
taxonomy:
    category: docs
routes:
  default: '/packaging_apps_helpers'
---

Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/{{ current_commit }}/doc/generate_helper_doc.py) on {{data.date}} (Yunohost version {{data.version}})

{% for category, helpers in data.helpers %}
### {{ category.upper() }}
{% for h in helpers %}
**{{ h.name }}**<br/>
[details summary="<i>{{ h.brief }}</i>" class="helper-card-subtitle text-muted"]
<p></p>

**Usage**: `{{ h.usage }}`
{%- if h.args %}

**Arguments**:
    {%- for infos in h.args %}
        {%- if infos|length == 2 %}
- `{{ infos[0] }}`: {{ infos[1] }}
        {%- else %}
- `{{ infos[0] }}`, `{{ infos[1] }}`: {{ infos[2] }}
        {%- endif %}
    {%- endfor %}
{%- endif %}
{%- if h.ret %}

**Returns**: {{ h.ret }}
{%- endif %}
{%- if "example" in h.keys() %}

**Example**: `{{ h.example }}`
{%- endif %}
{%- if "examples" in h.keys() %}

**Examples**:
    {% for example in h.examples %}
        {% if not example.strip().startswith("# ") %}
- `{{ example }}`
        {% else %}
- `{{ example.strip("# ") }}`
        {% endif %}
    {% endfor %}
{%- endif %}
{%- if h.details %}

**Details**:<br/>
{{ h.details }}
{%- endif %}

[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/{{ current_commit }}/data/helpers.d/{{ category }}#L{{ h.line + 1 }})
[/details]
----------------
{% endfor %}
{% endfor %}
{'fraction_non_alphanumeric': 0.26631853785900783, 'fraction_numerical': 0.0045691906005221935, 'mean_word_length': 2.7287104622871046, 'pattern_counts': {'":': 0, '<': 14, '<?xml version=': 0, '>': 14, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6581722', 'n_tokens_mistral': 1213, 'n_tokens_neox': 1087, 'n_words': 232}