{{ tool.description | markdownify }}
Usage
$ {{ tool_name }}{% if tool.commands %} command{% endif %}{% if command.options %} options{% endif %}
{% if commands %}
Commands
{% if tool.options %}{% assign options = tool.options %}
Options
Flag |
Description |
Default |
{% for option in options %}
{% assign flags = option.flags | split: ", " %}
{% for flag in flags %}
{{ flag }}
{% unless forloop.last %}, {% endunless %}
{% endfor %}
|
{{ option.description | markdownify }} |
{% if option.default %}{{ option.default | markdownify }}{% endif %}
|
{% endfor %}
{% endif %}
{% if tool.example %}
Example
{% endif %}
{% endif %}
{% if tool.env_vars %}{% assign vars = tool.env_vars %}
Environment variables
The table below lists the environment variables that you can use to configure the {{ tool_name }}
tool.
Variable |
Description |
Default |
{% for var in vars %}
{{ var.name }} |
{{ var.description }} |
{% if var.default %}{{ var.default }} {% endif %} |
{% endfor %}
{% endif %}
{% for command in commands %}{% assign subcommands = command.subcommands %}
{{ command.description | markdownify }}
Usage
$ {{ tool_name }} {{ command.name }}{% if command.subcommands %} subcommand{% endif %}{% if command.argument %} {{ command.argument }}{% endif %}{% if command.options %} options{% endif %}
{% if command.options %}{% assign options = command.options %}
Options
Flag |
Description |
Default |
{% for option in options %}
{% assign flags = option.flags | split: ", " %}
{% for flag in flags %}
{{ flag }}
{% unless forloop.last %}, {% endunless %}
{% endfor %}
|
{{ option.description | markdownify }} |
{% if option.default %}{{ option.default | markdownify }}{% endif %}
|
{% endfor %}
{% endif %}
{% if command.example %}
Example
{% endif %}
{% if subcommands %}
Subcommands
{% for subcommand in subcommands %}
{{ subcommand.description }}
Usage
$ {{ tool_name }} {{ command.name }} {{ subcommand.name }}{% if subcommand.argument %} {{ subcommand.argument }}{% endif %}{% if subcommand.options %} options{% endif %}
{% if subcommand.options %}{% assign options = subcommand.options %}
Options
Flag |
Description |
Default |
{% for option in options %}
{% assign flags = option.flags | split: ", " %}
{% for flag in flags %}
{{ flag }}
{% unless forloop.last %}, {% endunless %}
{% endfor %}
|
{{ option.description | markdownify }} |
{% if option.default %}{{ option.default | markdownify }}{% endif %}
|
{% endfor %}
{% endif %}
{% if subcommand.example %}
Example
$ {{ subcommand.example }}
{% endif %}
{% endfor %}
{% endif %}
{% endfor %}