A package manager that installs and runs Swift command line tool packages.
$ mint run realm/swiftlint 0.22.0
This would install and run SwiftLint version 0.22.0
Mint is designed to be used with Swift command line tools that build with the Swift Package Manager. It makes installing, running and distributing these tools much easier.
builds are cached globally by version easily run a specific version of a tool use different versions of a tool side by side easily run the latest version of a tool distribute your own tools without recipes and formulas
Homebrew is a popular method of distributing Swift executables, but that requires creating a formula and then maintaining that formula. Running specific versions of homebrew installations can also be tricky as only one global version is installed at any one time. Mint installs your tool via SPM and lets you run multiple versions of that tool, which are globally installed and cached on demand.
If your Swift executable package builds with SPM, then it can be run with Mint! See Support for details.
Why is it called Mint?
Swift Packager Manager Tools -> SPMT -> Spearmint -> Mint!
Make sure Xcode 9 is installed first.
$ brew tap yonaskolb/mint https://github.com/yonaskolb/mint.git $ brew install mint
$ git clone https://github.com/yonaskolb/mint.git $ cd mint $ make
Swift Package Manager
$ git clone https://github.com/yonaskolb/mint.git $ cd mint $ ./build/release/mint
Use as dependency
Add the following to your Package.swift file's dependencies:
.package(url: "https://github.com/yonaskolb/mint.git", from: "0.1.0"),
And then import wherever needed:
mint to see usage instructions.
$ mint Usage: mint [command] Available Commands: install Install a package run Run a package update Update a package Use "mint [command] --help" for more information about a command.
- Install: Installs a package. If it is already installed this won't do anything
- Run: Runs a package. This will install if first if it doesn't exist
- Update: Installs a package while enforcing an update and rebuild. Shouldn't be required unless you are pointing at a branch and want to update.
These commands all have 1 to 3 arguments:
- repo (required): This can be a shorthand for a github repo
install realm/SwiftLintor a fully qualified git path
install https://github.com/realm/SwiftLint.git. In the case of
runyou can also just pass the name of the repo if it is already installed
run swiftlint. This will do a lookup of all installed packages.
- version (optional): The git version of the packge. It is usually a tag but can also be a branch. If this is left out the version will default to the latest tag, or if there are no tags then master.
- command (optional): The command to install or run. This defaults to the the last path in the repo (so for
realm/swiftlintit will be
swiftlint). In the case of
runyou can also pass any arguments to the command but make sure the whole thing is surrounded by quotes eg
mint run realm/swiftlint 0.22.0 "swiftlint --path source"
$ mint install yonaskolb/xcodegen 1.2.0 "xcodegen --spec spec.yml" # pass some arguments $ mint install yonaskolb/xcodegen 1.2.0 # use version 1.2.0 $ mint install yonaskolb/xcodegen # use newest tag $ mint run yonaskolb/xcodegen 1.2.0 # run 1.2.0 $ mint run xcodegen # use newest tag and find xcodegen in installed tools
If your Swift command line tool builds with the Swift Package Manager than it will automatically install and run with mint! You can add this to your
Installing section in the readme:
### [Mint](https://github.com/yonaskolb/mint) ``` $ mint run github_name/repo_name ```
If your executable name is different from your repo name then you will need to append the name to the above command
The Swift Package Manager doesn't yet have a way of specifying resources directories. If your tool requires access to resources from the repo you require a custom
Package.resources file. This is a plain text file that lists the resources directories on different lines:
If this file is found in you repo, then all those directories will be copied into the same path as the executable.
A list of popular Mint compatible tools
mint run and the following:
Feel free to add your own!