tuco

README

tuco: Go port multiplexer

SUMMARY

tuco streamlines Go application porting.

EXAMPLE

% cd example

% tuco

% ls bin/hello-ports
hello-aix-ppc64.tgz
hello-darwin-amd64.tgz
hello-darwin-arm64.tgz
...

For more CLI option, run tuco -help.

For more ports, run go tool dist list.

DOWNLOAD

go install github.com/mcandre/tuco/cmd/tuco@latest

Prerequisites

• Go

For more platforms and installation methods, see our install guide.

ABOUT

tuco automates more low level steps involved in managing crosscompilation for Go projects. So that you can focus on developing your application.

FEATURES

• Parallelism
• IaC friendly
• Easy port selection with YAML comment toggles
• Automatically corrects chmod bits inside tarballs
• Logical directory structure for straightforward binary based OS packaging

CONFIGURATION

For details on tuning tuco, see our configuration guide.

RESOURCES

Prior art, personal plugs, and tools for developing portable applications (including non-Go projects)!

• mcandre/crit - Rust multiplexer
• mcandre/rockhopper - OS package multiplexer
• tree - an CLI file manager
• xgo - cGo multiplexer

🐹🍹

Documentation

Overview

Package tuco implements primitives for organizing Go crosscompilation.

Index

• Constants
• Variables
• type Port
  • func ParsePort(s string) (*Port, error)
  • func (o Port) MarshalYAML() (interface{}, error)
  • func (o Port) String() string
  • func (o *Port) UnmarshalYAML(value *yaml.Node) error
• type Tuco
  • func Load() (*Tuco, error)
  • func NewTuco() Tuco
  • func (o Tuco) Archive(port Port, outputPth string) error
  • func (o Tuco) Build(port Port) error
  • func (o Tuco) Clean() error
  • func (o Tuco) Run() []error
  • func (o *Tuco) UpdateMaxPortLen()
  • func (o *Tuco) UpdateTarballRoot()

Constants

const ConfigurationFilename = "tuco.yaml"

ConfigurationFilename denotes the location of the tuco configuration file, relative to the current working directory.

const DefaultArtifacts = "bin"

DefaultArtifacts denotes the default location of the artifact directory tree.

const DefaultJobs uint = 4

DefaultJobs denotes the default number of goroutines.

const Version = "0.0.21"

Version is semver.

Variables

var DefaultExcludes = []string{
	".DS_Store",
	"Thumbs.db",
}

DefaultExcludes collects file path patterns to strip from archives.

Types

type Port

type Port struct {
	// Os denotes a high-level environment.
	//
	// Example: "linux"
	Os string

	// Arch denotes a low-level environment.
	//
	// Example: "amd64"
	Arch string
}

Port models a basic targetable execution configuration.

func ParsePort

func ParsePort(s string) (*Port, error)

ParsePort constructs a port from a string. https://go.dev/wiki/PortingPolicy

func (Port) MarshalYAML

func (o Port) MarshalYAML() (interface{}, error)

MarshalYAML encodes YAML.

func (Port) String

func (o Port) String() string

String renders a port.

func (*Port) UnmarshalYAML

func (o *Port) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML decodes YAML.

type Tuco

type Tuco struct {
	// Debug enables additional logging.
	Debug bool `yaml:"debug,omitempty"`

	// Artifacts denotes the location of the toplevel artifacts directory (default: `DefaultArtifacts`).
	Artifacts string `yaml:"artifacts,omitempty"`

	// Banner denotes a software application identifier (required, nonblank).
	Banner string `yaml:"banner"`

	// Jobs limits the number of goroutines (default: `DefaultJobs`).
	Jobs uint `yaml:"jobs,omitempty"`

	// Excludes skips matching file paths from archival.
	//
	// Glob syntax
	// https://pkg.go.dev/path/filepath#Match
	Excludes []string `yaml:"excludes,omitempty"`

	// GoArgs collects additional `go build`... CLI flags
	GoArgs []string `yaml:"go_args,omitempty"`

	// Ports collects target ports.
	Ports []Port `yaml:"ports,omitempty"`
	// contains filtered or unexported fields
}

Tuco models a crossport build setup.

func Load

func Load() (*Tuco, error)

Load constructs a Tuco from `ConfigurationFilename`.

func NewTuco

func NewTuco() Tuco

NewTuco constructs a default Tuco.

func (Tuco) Archive

func (o Tuco) Archive(port Port, outputPth string) error

Archive compresses Go applications in conventional UNIX TGZ format.

func (Tuco) Build

func (o Tuco) Build(port Port) error

Build generates binaries for the given port.

func (Tuco) Clean

func (o Tuco) Clean() error

Clean removes artifacts.

func (Tuco) Run

func (o Tuco) Run() []error

Run crosscompiles and archives Go applications.

func (*Tuco) UpdateMaxPortLen

func (o *Tuco) UpdateMaxPortLen()

UpdateMaxPortLen calculates maxPortLen.

func (*Tuco) UpdateTarballRoot

func (o *Tuco) UpdateTarballRoot()

UpdateTarballRoot calculates binary archive root directories.