sgtool

Documentation

Overview

Package sgtool provides primitives for downloading and invoking tools.

Index

• Constants
• func CreateSymlink(src string) (string, error)
• func FromLocal(_ context.Context, filepath string, opts ...Opt) error
• func FromRemote(ctx context.Context, addr string, opts ...Opt) error
• func GoInstall(ctx context.Context, pkg, version string) (string, error)
• func GoInstallWithModfile(ctx context.Context, pkg, file string) (string, error)
• type Opt
  • func WithDestinationDir(path string) Opt
  • func WithHTTPHeader(key, value string) Opt
  • func WithRenameFile(src, dst string) Opt
  • func WithSkipIfFileExists(filepath string) Opt
  • func WithSymlink(path string) Opt
  • func WithUntar() Opt
  • func WithUntarGz() Opt
  • func WithUnzip() Opt

Constants

const (
	None archiveType = iota
	Zip
	Tar
	TarGz
)

const (
	AMD64 = "amd64"
	X8664 = "x86_64"
	ARM64 = "arm64"
)

const (
	Darwin = "darwin"
)

Functions

func CreateSymlink

func CreateSymlink(src string) (string, error)

func FromLocal

func FromLocal(_ context.Context, filepath string, opts ...Opt) error

FromLocal can be used to work with local archive files. HTTP related Options, such as WithHTTPHeader don't do anything here.

func FromRemote

func FromRemote(ctx context.Context, addr string, opts ...Opt) error

func GoInstall

func GoInstall(ctx context.Context, pkg, version string) (string, error)

func GoInstallWithModfile

func GoInstallWithModfile(ctx context.Context, pkg, file string) (string, error)

GoInstallWithModfile builds and installs a go binary given the package and a path to the local go.mod file.

Types

type Opt

type Opt func(f *fileState)

func WithDestinationDir

func WithDestinationDir(path string) Opt

func WithHTTPHeader

func WithHTTPHeader(key, value string) Opt

func WithRenameFile

func WithRenameFile(src, dst string) Opt

WithRenameFile renames a source file to the given destination file when writing it. For archives the source file should be the path relative to the root of the archive. If the archive does not contain a file with a matching src path, it is ignored. For direct downloads (no archive) the src does not matter and the output file is stored as per dst. The output file is stored relative to the destination dir given by WithDestinationDir.

func WithSkipIfFileExists

func WithSkipIfFileExists(filepath string) Opt

func WithSymlink

func WithSymlink(path string) Opt

func WithUntar

func WithUntar() Opt

func WithUntarGz

func WithUntarGz() Opt

func WithUnzip

func WithUnzip() Opt