gofish

README

GoFish, The Package Manager

Features, usage and installation instructions can be found on the homepage.

What does GoFish do?

GoFish is a cross-platform systems package manager, bringing the ease of use of Homebrew to Linux and Windows.

$ gofish install go
==> Installing go...
🐠  go 1.10.1: installed in 2.307602197s

GoFish works across all three major operating systems (Windows, MacOS, and Linux). It installs packages into its own directory and symlinks their files into /usr/local (or C:\ProgramData for Windows). You can think of it as the cross-platform Homebrew.

Want to add your project to the list of installable thingies?

Make a PR at fishworks/fish-food! Just make sure to follow the Contributing Guide first.

Troubleshooting

For troubleshooting, see the Troubleshooting Guide.

Security

Please email security issues to Matt Fisher.

License

GoFish is licensed under the Apache v2 License.

Documentation

Index

• Constants
• Variables
• type Food
  • func (f *Food) GetPackage(os, arch string) *Package
  • func (f *Food) Install() error
  • func (f *Food) Installed() bool
  • func (f *Food) Link(pkg *Package) error
  • func (f *Food) Linked() bool
  • func (f *Food) Uninstall() error
  • func (f *Food) Unlink(pkg *Package) error
• type Home
  • func (h Home) Barrel() string
  • func (h Home) DefaultRig() string
  • func (h Home) Path(elem ...string) string
  • func (h Home) Rigs() string
  • func (h Home) String() string
• type Package
• type Resource
• type UserHome
  • func (h UserHome) Cache() string
  • func (h UserHome) Path(elem ...string) string
  • func (h UserHome) String() string

Constants

const BinPath = HomePrefix + "/bin"

BinPath is the path to where executables should be installed by gofish.

const HomePrefix = "/usr/local"

HomePrefix is the base path to Fish's configuration directory.

Variables

var HomePath = filepath.Join(HomePrefix, "Fish")

HomePath is the path to Fish's configuration directory.

var UserHomePath = os.Getenv("HOME")

UserHomePath is the path to $HOME

Types

type Food

type Food struct {
	// The canonical name of the software.
	Name string
	// A (short) description of the software.
	Description string
	// The license identifier for the software.
	License string
	// The homepage URL for the software.
	Homepage string
	// Caveats inform the user about any Draft-specific caveats regarding this fish food.
	Caveats string
	// The version of the software.
	Version string
	// The list of binary distributions available for this fish food.
	Packages []*Package
}

Food provides metadata to install a piece of software.

func (*Food) GetPackage

func (f *Food) GetPackage(os, arch string) *Package

GetPackage does a lookup for a package supporting the given os/arch. If none were found, this returns nil.

func (*Food) Install

func (f *Food) Install() error

Install attempts to install the package, returning errors if it fails.

func (*Food) Installed

func (f *Food) Installed() bool

Installed checks to see if this fish food is installed. This is actually just a check for if the directory exists and is not empty.

func (*Food) Link

func (f *Food) Link(pkg *Package) error

Link creates links to any linked resources owned by the package.

func (*Food) Linked

func (f *Food) Linked() bool

Linked checks to see if a particular package owned by this fish food is linked to /usr/local/bin. This is just a check if the binaries symlinked in /usr/local/bin link back to the barrel.

func (*Food) Uninstall

func (f *Food) Uninstall() error

Uninstall attempts to uninstall the package, returning errors if it fails.

func (*Food) Unlink

func (f *Food) Unlink(pkg *Package) error

Unlink removes any linked resources owned by the package.

type Home

type Home string

Home designates where fish should store data.

func (Home) Barrel

func (h Home) Barrel() string

Barrel returns the path to the fish barrel.

func (Home) DefaultRig

func (h Home) DefaultRig() string

DefaultRig returns the name of the default fishing rig.

func (Home) Path

func (h Home) Path(elem ...string) string

Path returns Home with elements appended.

func (Home) Rigs

func (h Home) Rigs() string

Rigs returns the path to the fishing rigs.

func (Home) String

func (h Home) String() string

String returns Home as a string.

Implements fmt.Stringer.

type Package

type Package struct {
	// the running program's operating system target. One of darwin, linux, windows, and so on.
	OS string
	// the running program's architecture target. One of 386, amd64, arm, s390x, and so on.
	Arch      string
	Resources []*Resource
	// The URL used to download the binary distribution for this version of the fish food. The file must be a gzipped tarball (.tar.gz) or a zipfile (.zip) for unpacking.
	URL string
	// Additional URLs for this version of the fish food.
	Mirrors []string
	// To verify the cached download's integrity and security, we verify the SHA-256 hash matches what we've declared in the fish food.
	SHA256 string
}

Package provides metadata to install a piece of software on a given operating system and architecture.

type Resource

type Resource struct {
	// Path is the path relative from the root of the unpacked archive to the resource. The resource is symlinked into the InstallPath and, if Executable is set, made executable (chmod +x).
	Path string
	// InstallPath is the destination path relative from /usr/local. The resource is symlinked from Path to the InstallPath and, if Executable is set, made executable (chmod +x).
	InstallPath string
	// Executable defines whether or not this resource should be made executable (chmod +x). This only applies for MacOS/Linux and can be ignored on Windows.
	Executable bool
}

Resource is a installable thingy that should be moved into /usr/local from the install path, such as an executable, manpages, libraries, etc.

type UserHome

type UserHome string

UserHome designates the current user's home directory.

func (UserHome) Cache

func (h UserHome) Cache() string

Cache returns the path to the cache.

func (UserHome) Path

func (h UserHome) Path(elem ...string) string

Path returns Home with elements appended.

func (UserHome) String

func (h UserHome) String() string

String returns Home as a string.

Implements fmt.Stringer.