README
¶
About
Mage is a make-like build tool using Go. You write plain-old go functions, and Mage automatically uses them as Makefile-like runnable targets.
Installation
Mage has no dependencies outside the Go standard library, and builds with Go 1.7 and above (possibly even lower versions, but they're not regularly tested).
Using GOPATH with go version < 1.17
go get -u -d github.com/magefile/mage
cd $GOPATH/src/github.com/magefile/mage
go run bootstrap.go
Using Go Install with go version >= 1.18
go install github.com/magefile/mage@latest
mage -init
Instead of the @latest tag, you can specify the desired version, for example:
go install github.com/magefile/mage@v1.15.0
Using Go Modules
git clone https://github.com/magefile/mage
cd mage
go run bootstrap.go
This will download the code and then run the bootstrap script to build mage with
version infomation embedded in it. A normal go get (without -d) or go install will build the binary correctly, but no version info will be embedded.
If you've done this, no worries, just go to $GOPATH/src/github.com/magefile/mage
and run mage install or go run bootstrap.go and a new binary will be created
with the correct version information.
The mage binary will be created in your $GOPATH/bin directory.
You may also install a binary release from our releases page.
Demo
Discussion
Join the #mage channel on gophers slack
or post on the magefile google group
for discussion of usage, development, etc.
Documentation
See magefile.org for full documentation.
See pkg.go.dev/github.com/magefile/mage/mage for instructions on how to use Mage as a library.
Why?
Makefiles are hard to read and hard to write. Mostly because makefiles are essentially fancy bash scripts with significant white space and additional make-related syntax.
Mage lets you have multiple magefiles, name your magefiles whatever you want, and they're easy to customize for multiple operating systems. Mage has no dependencies (aside from go) and runs just fine on all major operating systems, whereas make generally uses bash which is not well supported on Windows. Go is superior to bash for any non-trivial task involving branching, looping, anything that's not just straight line execution of commands. And if your project is written in Go, why introduce another language as idiosyncratic as bash? Why not use the language your contributors are already comfortable with?
Thanks
If you use mage and like it, or any of my other software, and you'd like to show your appreciation, you can do so on my patreon:
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package internal provides shared utilities for the mage build tool.
|
Package internal provides shared utilities for the mage build tool. |
|
Package mage provides the core functionality for the mage build tool.
|
Package mage provides the core functionality for the mage build tool. |
|
magefiles
|
|
|
targets
Package targets defines the build targets for the mage project.
|
Package targets defines the build targets for the mage project. |
|
Package mg provides support functions for running mage targets.
|
Package mg provides support functions for running mage targets. |
|
Package parse provides parsing of Go source files to extract mage targets.
|
Package parse provides parsing of Go source files to extract mage targets. |
|
Package sh provides helpers for running shell commands.
|
Package sh provides helpers for running shell commands. |
|
Package target provides functions for checking if a file or directory is newer than another file or directory.
|
Package target provides functions for checking if a file or directory is newer than another file or directory. |