CLI-приложения на Go для продвинутых пользователей

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

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

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

Базовая структура CLI-приложения

Давайте создадим простое CLI-приложение, которое выводит приветствие.

package main

import (
	"fmt"
	"os"
)

func main() {
	if len(os.Args) > 1 {
		name := os.Args[1]
		fmt.Printf("Привет, %s!\n", name)
	} else {
		fmt.Println("Привет!")
	}
}

1. Импортирует пакеты fmt (для форматированного вывода) и os (для доступа к аргументам командной строки).
2. Функция main является точкой входа в программу.
3. os.Args - это слайс строк, содержащий аргументы командной строки os.Args[0] - это имя программы, а os.Args[1] и далее - аргументы, переданные пользователем.
4. Код проверяет, был ли передан хотя бы один аргумент. Если да, то он использует его как имя и выводит приветствие. В противном случае, он выводит простое приветствие.

Чтобы запустить это приложение, сохраните код в файл hello.go, скомпилируйте его с помощью go build hello.go и запустите исполняемый файл ./hello (или .\hello.exe в Windows).

Вы можете запустить его без аргументов ./hello (или .\hello.exe в Windows)

или с аргументом ./hello дзен (или .\hello.exe дзен в Windows).

Обработка флагов с помощью пакета flag

Для более сложных CLI-приложений необходимо обрабатывать флаги (опции), которые позволяют пользователю настраивать поведение программы. Пакет flag в Go предоставляет удобный способ для этого.

package main

import (
	"flag"
	"fmt"
)

func main() {
	// Определяем флаги
	name := flag.String("name", "World", "Имя для приветствия")
	times := flag.Int("times", 1, "Количество повторений приветствия")

	// Парсим флаги
	flag.Parse()

	// Выводим приветствие указанное количество раз
	for i := 0; i < *times; i++ {
		fmt.Printf("Привет, %s!\n", *name)
	}
}

Мы определяем два флага: name (строка) и times (целое число). flag.String и flag.Int принимают имя флага, значение по умолчанию и описание.

flag.Parse() парсит аргументы командной строки и присваивает значения флагам.

Мы используем разыменование "*" для доступа к значениям флагов, так как flag.String и flag.Int возвращают указатели на значения.

Теперь вы можете запустить это приложение с флагами:

• ./app -name дзен -times 3 (.\app.exe -name дзен -times 3 в Windows) - выведет Привет, дзен! три раза)
• ./app -times 5 (.\app.exe -times 5 в Windows) - выведет Привет, World! пять раз
• ./app (.\app.exe в Windows) - выведет Привет, World! один раз

Подкоманды и библиотеки сторонних разработчиков

Для создания действительно мощных CLI-приложений часто требуется поддержка подкоманд (например, git commit, git push) и более сложная логика обработки аргументов. В этом случае рекомендуется использовать библиотеки сторонних разработчиков, такие как:

cobra: популярная библиотека для создания CLI-приложений с поддержкой подкоманд, флагов и автоматической генерацией справки.

urfave/cli: еще одна мощная библиотека для создания CLI-приложений с широким набором функций.

spf13/viper: библиотека для управления конфигурацией приложения, которая может использоваться для чтения флагов, файлов конфигурации и переменных окружения.

Использование этих библиотек значительно упрощает разработку сложных CLI-приложений и позволяет сосредоточиться на бизнес-логике.

Пример с использованием cobra:

package main

import (
	"fmt"

	"github.com/spf13/cobra"
)

var rootCmd = &cobra.Command{
	Use:   "mycli",
	Short: "Простое CLI-приложение",
	Long:  "Это пример CLI-приложения, созданного с использованием cobra.",
}
var helloCmd = &cobra.Command{
	Use:   "hello [name]",
	Short: "Выводит приветствие",
	Long:  "Выводит приветствие с указанным именем.",
	Args:  cobra.MinimumNArgs(1),
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Printf("Привет, %s!\n", args[0])
	},
}

func main() {
	rootCmd.AddCommand(helloCmd)
	rootCmd.Execute()
}

go mod init

go mod tidy