Installation

Getting started with goenums is simple. Since it’s a code generation tool that runs during development rather than a runtime dependency, you just need to install the CLI tool.

Via Go Install

The recommended way to install goenums is via Go’s built-in package manager:

go install github.com/zarldev/goenums@latest

This will download, compile, and install the latest version of goenums, making it available in your system’s Go binary directory ($GOPATH/bin or $GOBIN).

Verify Installation

To verify that goenums was installed correctly, run:

$ goenums -v

You should see the goenums logo and current version displayed:

   ____ _____  ___  ____  __  ______ ___  _____
  / __ '/ __ \/ _ \/ __ \/ / / / __ '__ \/ ___/
 / /_/ / /_/ /  __/ / / / /_/ / / / / / (__  ) 
 \__, /\____/\___/_/ /_/\__,_/_/ /_/ /_/____/  
/____/

    https://zarldev.github.io/goenums 
       version :: v0.4.0
       build   :: 20250528-00:39:58
       commit  :: 1b2f884-dirty

Prerequisites

• Go 1.23+ for full functionality including iterator support
• Go 1.18-1.22 use the -l flag to generate code without iterator support

Zero Dependencies

goenums is completely dependency-free, using only the Go standard library. This ensures minimal bloat, maximum stability, and eliminates dependency-related security concerns.

Next Steps: Learn how to use goenums in your project.