Skip to content
go-branded-id

Installation

Requirements

Section titled “Requirements”
  • Go 1.26 or later
  • GOEXPERIMENT=jsonv2 enabled (this library uses encoding/json/v2)
  • An active Go module (go.mod)

Install

Section titled “Install”

Run this in your project directory:

Terminal window
GOEXPERIMENT=jsonv2 go get github.com/larsartmann/go-branded-id

Enable GOEXPERIMENT=jsonv2

Section titled “Enable GOEXPERIMENT=jsonv2”

This library imports encoding/json/v2, which requires the jsonv2 experiment flag. Set it for all Go commands:

Terminal window
export GOEXPERIMENT=jsonv2

For a permanent setup, add it to your shell profile (~/.bashrc, ~/.zshrc) or to go env:

Terminal window
go env -w GOEXPERIMENT=jsonv2

Quick Usage

Section titled “Quick Usage”
package main


import (
    "fmt"


    "github.com/larsartmann/go-branded-id"
)


type UserBrand struct{}


type UserID = id.ID[UserBrand, string]


func main() {
    userID := id.NewID[UserBrand]("user-123")
    fmt.Println(userID.Get()) // user-123
}

Verify Installation

Section titled “Verify Installation”
Terminal window
GOEXPERIMENT=jsonv2 go list -m github.com/larsartmann/go-branded-id

Next Steps

Section titled “Next Steps”