https://github.com/lithammer/shortuuid

A generator library for concise, unambiguous and URL-safe UUIDs
https://github.com/lithammer/shortuuid

go golang shortuuid uuid

Last synced: 3 days ago
JSON representation

A generator library for concise, unambiguous and URL-safe UUIDs

• Host: GitHub
• URL: https://github.com/lithammer/shortuuid
• Owner: lithammer
• License: mit
• Created: 2015-10-18T19:07:46.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-12-02T11:57:11.000Z (11 days ago)
• Last Synced: 2024-12-02T22:02:17.517Z (10 days ago)
• Topics: go, golang, shortuuid, uuid
• Language: Go
• Homepage: https://pkg.go.dev/github.com/lithammer/shortuuid/v4
• Size: 179 KB
• Stars: 1,199
• Watchers: 11
• Forks: 56
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-golang-repositories - shortuuid - safe UUIDs (Repositories)
• awesome-ccamel - lithammer/shortuuid - A generator library for concise, unambiguous and URL-safe UUIDs (Go)

README

        
# shortuuid

[![Build Status](https://github.com/lithammer/shortuuid/workflows/CI/badge.svg)](https://github.com/lithammer/shortuuid/actions)

[![Godoc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://pkg.go.dev/github.com/lithammer/shortuuid/v4)

A Go library that generates concise, unambiguous, URL-safe UUIDs. Based on and

compatible with the Python library

[`shortuuid`](https://github.com/skorokithakis/shortuuid).

Often, one needs to use non-sequential IDs in places where users will see them,

but the IDs must be as concise and easy to use as possible. shortuuid solves

this problem by generating UUIDs using

[google/uuid](https://github.com/google/uuid) and then translating them to

base57 using lowercase and uppercase letters and digits, and removing

similar-looking characters such as l, 1, I, O and 0.

## Usage

```go

package main

import (

	"fmt"

	"github.com/lithammer/shortuuid/v4"

)

func main() {

	u := shortuuid.New()

	fmt.Println(u) // KwSysDpxcBU9FNhGkn2dCf

}

```

To use UUID v5 (instead of the default v4), use `NewWithNamespace(name string)`

instead of `New()`.

```go

shortuuid.NewWithNamespace("http://example.com")

```

It's possible to use a custom alphabet as well (at least 2

characters long).  

It will automatically sort and remove duplicates from your alphabet to ensure consistency

```go

alphabet := "23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxy="

shortuuid.NewWithAlphabet(alphabet) // iZsai==fWebXd5rLRWFB=u

```

Bring your own encoder! For example, base58 is popular among bitcoin.

```go

package main

import (

	"fmt"

	"github.com/btcsuite/btcutil/base58"

	"github.com/google/uuid"

	"github.com/lithammer/shortuuid/v4"

)

type base58Encoder struct{}

func (enc base58Encoder) Encode(u uuid.UUID) string {

	return base58.Encode(u[:])

}

func (enc base58Encoder) Decode(s string) (uuid.UUID, error) {

	return uuid.FromBytes(base58.Decode(s))

}

func main() {

	enc := base58Encoder{}

	fmt.Println(shortuuid.NewWithEncoder(enc)) // 6R7VqaQHbzC1xwA5UueGe6

}

```

## License

MIT