Как создать CLI-инструмент на Go: руководство с примерами

Создание CLI-инструментов — это настоящая проверка твоих разработческих навыков. Go Cobra — это именно те инструменты, которые делают эту задачу легче и интереснее. Представь себе: можно управлять процессами и конфигурациями, используя только командную строку, и это окутано особой магией. CLI (Command Line Interface) — это приложения, которые выполняются в терминале и взаимодействуют с пользователем через команды и аргументы. Но почему Golang так хорош для создания CLI-инструментов? Давай разберемся.

А на практике с нуля обучиться разработке на этом языке можно на курсах FoxmindEd.

Что такое CLI и почему Go подходит для его создания?

CLI — это способ взаимодействия с программой без графического интерфейса, при помощи команд и параметров. Когда тебе нужно автоматизировать задачи или управлять системными процессами, CLI становится лучшим другом. А разработка CLI на Go позволяет достичь высокой производительности и стабильности, поскольку Go идеально подходит для работы с многопоточностью и сложными процессами.

Основные преимущества CLI-инструментов на Go

Это, во-первых, производительность. У Go низкий порог входа, отличная поддержка многозадачности, и его компилируемые бинарные файлы легко распространять. Во-вторых, Go-программы также достаточно просты в разработке и поддержке, благодаря его структурированному коду. В результате CLI-инструменты Go работают быстро, стабильно и не требуют громоздких зависимостей.

Обзор популярных библиотек для создания CLI на Go

Чтобы не писать все с нуля, можно воспользоваться готовыми библиотеками. Самая популярная — Cobra, но есть и другие:

• Urfave/cli: легковесная и простая, отлично подходит для небольших проектов. С ней можно быстро создать командный интерфейс, и она предоставляет интуитивный API, поддерживающий флаги и аргументы.
• Survey: удобна для создания CLI-инструментов, где требуется ввод данных от пользователя. Survey предлагает набор готовых виджетов (вопросов, полей ввода, выбора) для интерактивного CLI, что идеально подходит для приложений с большим объемом взаимодействий с пользователем.
• Mow.cli: минималистичная и быстрая, с простым синтаксисом. Она отлично подходит для небольших CLI-программ и позволяет легко управлять аргументами и командами.

Но мы выберем Cobra, чтобы продемонстрировать go cli примеры, ведь данный библиотека покрывает основные потребности и значительно ускоряет разработку.

Использование Cobra для создания CLI на Go

Что такое Cobra и как она упрощает разработку CLI?

Ты уже понял, что Cobra — это библиотека для создания CLI-приложений на Go. Она особенно полезна для разработки CLI-инструментов, где нужна поддержка большого количества команд и параметров.

Установка и настройка библиотеки Cobra

Для начала установи библиотеку Cobra. Введи в командной строке:

go get -u github.com/spf13/cobra

Затем создай новый файл для нашего CLI-приложения. Можно назвать его main.go. Далее, добавь в него подключение Cobra и начальную команду. 

FoxmindEd — это учебный центр с большим выбором направлений курсов для новичков и программистов с опытом!

Начинаете свой путь в IТ? Попробуйте курсы Start

Имеете базовые навыки программирования? Тогда вам на курсы Junior

Хотите углубить свои знания в IТ? У нас есть курсы Middle/Senior

Пример создания простого CLI с использованием Cobra

А теперь, создадим команду hello, которая будет просто выводить приветственное сообщение. Открой main.go и добавь следующую структуру кода:

package main

import (

    "fmt"

    "github.com/spf13/cobra"

)

func main() {

    var rootCmd = &cobra.Command{Use: "app"}

    var helloCmd = &cobra.Command{

        Use:   "hello",

        Short: "Print Hello World",

        Run: func(cmd *cobra.Command, args []string) {

            fmt.Println("Hello, World!")

        },

    }

    rootCmd.AddCommand(helloCmd)

    rootCmd.Execute()

}

Этот пример показывает, как легко добавлять команды и обрабатывать аргументы с помощью Cobra, упрощая разработку CLI на Go. 

Структура проекта для CLI-инструментов на Go

Как организовать структуру проекта для CLI?

Правильная структура проекта Golang упрощает управление кодом и добавление новых функций. Создавая CLI-инструмент, лучше придерживаться стандартной структуры Go, разделяя логику на пакеты и файлы для лучшей читаемости и поддержки кода.

Работа с конфигурациями и параметрами команд

Когда ты работаешь с CLI, часто необходимо сохранять и читать настройки. Здесь поможет файл конфигурации, например, config.yaml, который позволяет сохранять параметры. Библиотека viper отлично работает с Cobra и упрощает настройку конфигураций. Viper поддерживает YAML, JSON, TOML и другие форматы.

Лучшая практика организации кода для CLI-приложений

Разделяй команды по файлам. Используй отдельные файлы для каждой команды, как в примере выше, и описывай их функционал в файлах cmd/. Такой подход улучшает читаемость и удобство разработки CLI-инструмента. Это также упростит добавление новых команд и тестирование.

Разработка и тестирование CLI-инструментов на Go

Пример разработки CLI-инструмента с поддержкой нескольких команд

Создадим команду status, которая будет выводить состояние приложения, и команду version, которая покажет текущую версию CLI:

var statusCmd = &cobra.Command{

    Use:   "status",

    Short: "Print application status",

    Run: func(cmd *cobra.Command, args []string) {

        fmt.Println("Application is running")

    },

}

var versionCmd = &cobra.Command{

    Use:   "version",

    Short: "Print the version number",

    Run: func(cmd *cobra.Command, args []string) {

        fmt.Println("CLI version 1.0")

    },

}

Добавь эти команды в root.go, чтобы они работали как часть твоего CLI-инструмента.

Как тестировать CLI-инструменты в Go?

Тестирование CLI-инструментов может быть вызовом, так как нужно проверять выполнение команд в терминале. Go поддерживает написание тестов для CLI. Например, можно использовать os/exec для запуска команд и проверки их вывода:

package main

import (

    "os/exec"

    "testing"

)

func TestHelloCommand(t *testing.T) {

    cmd := exec.Command("go", "run", "main.go", "hello")

    out, err := cmd.Output()

    if err != nil {

        t.Fatal(err)

    }

    if string(out) != "Hello, World!\n" {

        t.Errorf("expected 'Hello, World!', got '%s'", out)

    }

}

Этот тест запускает команду hello и проверяет ее вывод.

Добавление пользовательских флагов и аргументов

Флаги позволяют более гибко настраивать поведение команды. Добавим флаг к команде hello, чтобы она могла приветствовать по имени. Для этого добавь к коду:

helloCmd.Flags().StringP(«name», «n», «World», «Name to greet»)

Теперь можно запускать go run main.go hello -n Go и получать приветствие: «Hello, Go!».

Заключение

Создание CLI-инструмента Go — увлекательный и полезный опыт для разработчиков, работающих с автоматизацией. Теперь у тебя есть мощный инструмент, который стабилен и легко масштабируется для новых команд и функций.