selfupdater

README

SelfUpdater

Motivation

Eliminate copy-paste self-update logic across personal CLI projects. Designed for GoReleaser-based release workflows.

Features

• Automatic version checking against GitHub releases
• Platform-specific asset selection
• Checksum verification
• Safe binary update with rollback support

Installation

go get github.com/marianozunino/selfupdater

Usage

package main

import selfupdater "github.com/marianozunino/selfupdater/pkg/selfupdater"

func main() {
    // Create an updater instance
    updater := selfupdater.NewUpdater(
        "your-github-username",   // GitHub owner
        "your-repo-name",         // Repository name
        "your-binary-name",       // Binary name (matching GoReleaser config)
        "current-version"         // Current version of your application
    )

    // Perform update check and apply if needed
    updater.Update()
}

Optional Authentication

If you're using a private repository or need higher API rate limits:

updater := selfupdater.NewUpdater(
    "owner",
    "repo",
    "binary",
    "version",
    selfupdater.WithToken("your-github-token")
)

License

MIT License

Documentation

Index

• type Asset
• type Option
  • func WithToken(token string) Option
• type Updater
  • func NewUpdater(owner, repo, binaryName, currentVersion string, options ...Option) *Updater
  • func (u *Updater) Update()

Types

type Asset

type Asset struct {
	ID       int64
	Name     string
	Checksum string
}

type Option

type Option func(*Updater)

func WithToken

func WithToken(token string) Option

type Updater

type Updater struct {
	CurrentVersion string
	Owner          string
	Repo           string
	BinaryName     string
	// contains filtered or unexported fields
}

func NewUpdater

func NewUpdater(owner, repo, binaryName, currentVersion string, options ...Option) *Updater

func (*Updater) Update

func (u *Updater) Update()