You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
|
|
|
# Hestia CLI Documentation
|
|
|
|
|
|
|
|
|
|
|
|
## Labels
|
|
|
|
|
|
|
|
|
|
|
|
Hint: use Ctrl+F to find them on page
|
|
|
|
|
|
|
|
|
|
|
|
- `{hestia}`: commands that are unique to Hestia and not inherited from Vesta
|
|
|
|
|
|
- `{panel}`: panel-specific commands
|
|
|
|
|
|
- `{dns}`: DNS-specific commands
|
|
|
|
|
|
- `{mail}`: mail-specific commands
|
|
|
|
|
|
|
|
|
|
|
|
## Contents
|
|
|
|
|
|
|
|
|
|
|
|
Hint: command short descriptions are displayed on hover
|
|
|
|
|
|
|
|
|
|
|
|
{% for cmdName, cmd in cmds %}
|
|
|
|
|
|
- [{{ cmdName }}](#{{ cmdName }} "{{ cmd.info | mdLinkTitle }}") {% for label in cmd.labels %}`{{ '{' + (label | mdCode) + '}' }}` {% endfor %}
|
|
|
|
|
|
|
|
|
|
|
|
{% endfor %}
|
|
|
|
|
|
|
|
|
|
|
|
## Commands
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{% for cmdName, cmd in cmds %}
|
|
|
|
|
|
### {{ cmdName }} {% for label in cmd.labels %}`{{ '{' + (label | mdCode) + '}' }}` {% endfor %}
|
|
|
|
|
|
|
|
|
|
|
|
{% if cmd.info %}
|
|
|
|
|
|
*{{ cmd.info | md }}*
|
|
|
|
|
|
{% endif %}
|
|
|
|
|
|
|
|
|
|
|
|
**Options**: {% for option in cmd.options %}{{ '–' if (option === 'NONE') else ('`' + (option | mdCode) + '`') }} {% endfor %}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{% if cmd.examples.length %}
|
|
|
|
|
|
**Examples**:
|
|
|
|
|
|
{% for example in cmd.examples %}
|
|
|
|
|
|
```{{ 'php' if cmd.php else 'bash' }}
|
|
|
|
|
|
{{ example | mdCode }}
|
|
|
|
|
|
```
|
|
|
|
|
|
{% endfor %}
|
|
|
|
|
|
{% endif %}
|
|
|
|
|
|
|
|
|
|
|
|
{{ cmd.desc | md }}
|
|
|
|
|
|
|
|
|
|
|
|
{% endfor %}
|
