Параметры запуска¶

Все доступные флаги и параметры Go Project Starter.

Основные параметры¶

--config¶

Путь к файлу конфигурации проекта.

go-project-starter --config=my-config.yaml
go-project-starter --config=configs/production.yaml

По умолчанию: project.yaml

--configDir¶

Директория, содержащая файлы конфигурации.

go-project-starter --configDir=.project-config --config=project.yaml

По умолчанию: текущая директория

Полезно для организации:

.project-config/
├── project.yaml      # Основная конфигурация
├── openapi.yaml      # API спецификация
└── users.proto       # Protobuf файлы

--target¶

Целевая директория для генерации проекта.

go-project-starter --config=config.yaml --target=./my-service

По умолчанию: текущая директория

--dry-run¶

Режим предпросмотра — показать изменения без записи файлов.

go-project-starter --dry-run --config=config.yaml --target=./my-service

Вывод показывает:

Какие файлы будут созданы
Какие файлы будут изменены
Какие файлы будут удалены

Информационные параметры¶

--help, -h¶

Показать справку по команде.

go-project-starter --help
go-project-starter init --help
go-project-starter setup --help

--version¶

Показать версию генератора.

go-project-starter --version

Примеры использования¶

Генерация нового проекта¶

# Создать конфигурацию через wizard
go-project-starter init --target=.

# Сгенерировать проект
go-project-starter --configDir=.project-config --target=.

# Настроить CI/CD
go-project-starter setup --configDir=.project-config --target=.

Регенерация существующего проекта¶

# Предпросмотр изменений
go-project-starter --dry-run --configDir=.project-config --target=.

# Применить изменения
go-project-starter --configDir=.project-config --target=.

Генерация во временную директорию (тестирование)¶

go-project-starter --config=config.yaml --target=/tmp/test-project
cd /tmp/test-project
go build ./...

Переменные окружения¶

Генератор может использовать переменные окружения для некоторых настроек:

Переменная	Описание
`GOPROXY`	Go proxy для загрузки зависимостей
`GOPRIVATE`	Список приватных Go модулей

Post-generation шаги¶

После генерации автоматически выполняются шаги, указанные в конфигурации:

post_generate:
  - git_install      # Инициализировать git репозиторий
  - tools_install    # Установить инструменты (ogen, argen, golangci-lint)
  - clean_imports    # Организовать imports через goimports
  - executable_scripts  # chmod +x для скриптов
  - call_generate    # Запустить make generate
  - go_mod_tidy      # Запустить go mod tidy

Шаги можно отключить, убрав их из списка.