Installation¶

Prerequisites¶

Before you begin, ensure you have the following installed:

Go 1.21+: Download Go
Git: Download Git
Make: Usually comes with your OS or development tools

Installation Methods¶

Option 1: Go Install (Recommended)¶

1	`go install github.com/mavogel/cli-template@latest`

Option 2: Download Binary¶

Visit the Releases page
Download the appropriate binary for your OS
Extract and place in your PATH

Option 3: Homebrew (macOS/Linux)¶

brew tap mavogel/homebrew-tap
brew install cli-template

Option 4: Build from Source¶

# Clone the repository
git clone https://github.com/mavogel/cli-template.git
cd cli-template

# Build the binary
make build

# Install to your PATH
make install

Verify Installation¶

cli-template --version
cli-template --help

Development Setup¶

If you plan to contribute or modify the code:

# Clone the repository
git clone https://github.com/mavogel/cli-template.git
cd cli-template

# Install dependencies
go mod download

# Install development tools
make dev-tools

# Run tests
make test

# Run linting
make lint

Development Dependencies¶

The following tools are recommended for development:

golangci-lint: Code linting
GoReleaser: Release automation
MkDocs: Documentation generation

Install them with:

# golangci-lint
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

# GoReleaser
go install github.com/goreleaser/goreleaser@latest

# Docker (for MkDocs documentation)
brew install --cask docker