Центрирование

Clikt (произносится как "кликт") — это многоплатформенная библиотека на Kotlin, которая делает создание командных строковых интерфейсов простым и интуитивно понятным процессом. Это "Командный линейный интерфейс для Kotlin".

Библиотека спроектирована таким образом, чтобы сделать процесс создания командных строковых инструментов беспроблемным, при этом поддерживаются широкий спектр случаев использования и позволяется продвинутая настройка при необходимости.

Clikt имеет следующие возможности:

• произвольное вложение команд;
• компонуемые, типоустойчивые значения параметров;
• генерацию справочной информации и скриптов автозаполнения командной строки;
• многоплатформенные пакеты для JVM, Node.js и нативных Linux, Windows и macOS.

Как выглядит это на практике? Вот полный пример простой программы на Clikt:

class Приветствие : CliktCommand() {
    val количество: Int by option("--count").int().default(1).help("Количество приветствий")
    val имя: String by option("--name").prompt("Введите ваше имя").help("Человек, которому предназначено приветствие")

    override fun run() {
        repeat(количество) {
            echo("Привет, $имя!")
        }
    }
}

fun main(args: Array<String>) = Приветствие().main(args)

А вот что получается при запуске программы:

Ошибки также учитываются:

Документация

Полная документация доступна на веб-сайте.

Также есть несколько примеров приложений. Вы можете запустить их с помощью включенного скрипта runsample.

Установка

Clikt распространяется через Maven Central.

dependencies {
    implementation("com.github.ajalt.clikt:clikt:5.0.3")

    // необязательная поддержка отображения markdown в сообщениях помощи
    implementation("com.github.ajalt.clikt:clikt-markdown:5.0.3")
}

Также существует более маленький модуль ядра. Подробности см. в документации.

Если вы используете Maven вместо Gradle, используйте <artifactId>clikt-jvm</artifactId>.

Многоплатформенный подход

Clikt поддерживает большинство многоплатформенных целевых объектов. Подробнее см. в документации по поводу функциональности, поддерживаемой на каждом целевом объекте. Вам потребуется использовать Gradle версии 6 или выше.

Снимки экрана

Лицензия

Copyright 2018 AJ Alt

Распространяется в соответствии с лицензией Apache, версия 2.0 ("Лицензия").
Вы можете использовать этот файл только в соответствии с Лицензией.
Вы можете получить копию Лицензии по адресу:

    http://www.apache.org/licenses/LICENSE-2.0

В случае отсутствия требований применимого закона или письменного соглашения,
программное обеспечение распространяется на условиях "КАК ЕСТЬ".
Без каких-либо гарантий или условий любого типа, явных или подразумевающихся.
См. Лицензию для конкретного языка, регулирующего права использования и
ограничения, связанные с Лицензией.