Skip to content

Installation

HexaGo requires Go 1.21 or later. Choose your preferred installation method below.


Using Go Install

The simplest method — installs the latest release directly from the module proxy:

go install github.com/padiazg/hexago@latest

To install a specific version:

go install github.com/padiazg/hexago@v0.0.2

Tip

Make sure $GOPATH/bin (or $HOME/go/bin) is in your PATH:

export PATH="$PATH:$(go env GOPATH)/bin"


Using Homebrew

brew tap padiazg/hexago
brew install hexago

Build from Source

git clone https://github.com/padiazg/hexago.git
cd hexago
go build -o hexago

Then move the binary somewhere on your PATH:

mv hexago /usr/local/bin/hexago
# or
mv hexago ~/go/bin/hexago

Verify Installation

hexago --help

You should see output like:

HexaGo - Hexagonal Architecture Scaffolding CLI

Usage:
  hexago [command]

Available Commands:
  init        Initialize a new hexagonal architecture project
  add         Add components to an existing project
  validate    Validate hexagonal architecture compliance

Flags:
  -h, --help      help for hexago
  -v, --verbose   Enable verbose output

Prerequisites

Requirement Version Notes
Go 1.21+ Required to install and build
Git Any For cloning and version control

Note

HexaGo generates static binaries (CGO_ENABLED=0), so generated projects can be deployed without external dependencies.


Platform Support

Pre-built binaries are available for:

  • Linux x86_64
  • Linux arm64
  • macOS x86_64 (Intel)
  • macOS arm64 (Apple Silicon)

Download from GitHub Releases.


Next Steps

Once installed, head to the Quick Start guide to create your first project.