CLI Commands

{% for command in data.ckan_cli_commands %}

{% if command.help %}

Help:

{{ command.help }}
{% else %}

No help text available.

{% endif %} {% if command.arguments %}

Arguments:

    {% for arg in command.arguments %}
  • {{ arg.name }} — {{ arg.help or 'No description' }} {% if arg.required %}(required){% endif %}
  • {% endfor %}
{% endif %} {% if command.options %}

Options:

    {% for opt in command.options %}
  • {{ opt.opts | join(', ') }} — {{ opt.help or 'No description' }} {% if opt.required %}(required){% endif %}
  • {% endfor %}
{% endif %}

Example usage:

ckan {{ command.name }} {% for arg in command.arguments if arg.required %}<{{ arg.name }}> {% endfor %}
{% if command.subcommands %}
{% for sub in command.subcommands %}

{% if sub.help %}

Help:

{{ sub.help }}
{% endif %} {% if sub.arguments %}

Arguments:

    {% for arg in sub.arguments %}
  • {{ arg.name }} — {{ arg.help or 'No description' }} {% if arg.required %}(required){% endif %}
  • {% endfor %}
{% endif %} {% if sub.options %}

Options:

    {% for opt in sub.options %}
  • {{ opt.opts | join(', ') }} — {{ opt.help or 'No description' }} {% if opt.required %}(required){% endif %}
  • {% endfor %}
{% endif %}

Example usage:

ckan {{ command.name }} {{ sub.name }} {% for arg in sub.arguments if arg.required %}<{{ arg.name }}> {% endfor %}
{% endfor %}
{% endif %}
{% endfor %}