magecraft

README

magecraft

A small Go module to make it easier and quicker to execute commands for use with Magefiles.

Getting Started

Installation

go get -u github.com/kkrypt0nn/magecraft

Example Usage

package main

import "github.com/kkrypt0nn/magecraft"

func main() {
	if err := magecraft.Docker.RunContainer(magecraft.DockerRunContainerOpts{
		Name:  "sftp",
		Image: "atmoz/sftp",
		Ports: []string{"2222:22"},
		ExtraArgs: []string{
			"foo:bar:::baz",
		},
	}); err != nil {
		panic(err)
	}
}

Supported Commands

Docker

Method	Command
Docker.BuildImage(opts)	docker build ...
Docker.RunContainer(opts)	docker run ...
Docker.ExecInContainer(name, args...)	docker exec ...
Docker.RemoveContainer(name)	docker rm -f ...

Go

Method	Command
Go.Build(opts)	go build ...

Helm

Method	Command
Helm.AddRepo(name, url)	helm repo add ...
Helm.UpdateRepos()	helm repo update
Helm.Upgrade(opts)	helm upgrade ...
Helm.Uninstall(releaseName, namespace)	helm uninstall ...

License

This library was made with 💜 by Krypton and is under the MIT License.

Documentation

Index

• Variables
• type DockerBuildImageOpts
• type DockerRunContainerOpts
• type GoBuildOpts
• type HelmUpgradeOpts

Variables

var Docker dockerCommands

var Go goCommands

var Helm helmCommands

Types

type DockerBuildImageOpts

type DockerBuildImageOpts struct {
	Dockerfile   string
	ImageName    string
	ImageVersion string
	Context      string
	BuildArgs    map[string]string
}

type DockerRunContainerOpts

type DockerRunContainerOpts struct {
	Name      string
	Image     string
	Ports     []string
	Volumes   []string
	Env       map[string]string
	ExtraArgs []string
}

type GoBuildOpts

type GoBuildOpts struct {
	Target  string
	Output  *string
	LdFlags []string
	Tags    []string
}

type HelmUpgradeOpts

type HelmUpgradeOpts struct {
	Install           bool
	ReleaseName       string
	RepoName          string
	ChartName         string
	Version           *string
	Namespace         *string
	CreateNamespace   bool
	DisableServerSide bool
	ValuesFile        *string
	Values            map[string]string
}