A package manager that installs and runs Swift command line tool packages.
$ mint run realm/SwiftLint@0.22.0 swiftlint
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.
- ✅ easily run a specific version of a tool
- ✅ install a tool globally
- ✅ builds are cached by version
- ✅ 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! 🌱😄
Mint: a place where something is produced or manufactured
Make sure Xcode 9.2 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
Using Mint itself!
$ git clone https://github.com/yonaskolb/Mint.git $ cd Mint $ swift run mint install yonaskolb/mint
$ mint install yonaskolb/mint
Swift Package Manager
$ git clone https://github.com/yonaskolb/Mint.git $ cd Mint $ swift run 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 --help to see usage instructions.
- install: Installs a package, so it can be run with
runlater, and also links that version globally
- run: Runs a package. This will install it first if it isn't already installed, though won't link it globally. It's useful for running a certain version.
- 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 it.
- list: Lists all currently installed packages and versions.
- uninstall: Uninstalls a package by name.
Run, install and update commands have 1 or 2 arguments:
- package (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. An optional version can be specified by appending
@version, otherwise the newest tag or master will be used. Note that if you don't specify a version, the current tags must be loaded remotely each time.
- 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 eg
mint run realm/swiftlint swiftlint --path source
$ mint run yonaskolb/XcodeGen@1.2.4 xcodegen --spec spec.yml # pass some arguments $ mint install yonaskolb/XcodeGen@1.2.4 --global=false # installs a certain version but not globally $ mint install yonaskolb/XcodeGen # install newest tag $ mint run yonaskolb/XcodeGen@1.2.4 # run 1.2.4 $ mint run XcodeGen # use newest tag and find XcodeGen in installed tools
By default Mint symlinks your installs into
update are used, unless
--global=false is passed. This means a package will be accessible from anywhere, and you don't have to prepend commands with
mint run. Note that only one global version can be installed at a time though. If you need to run a specific older version use
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 the
Installing section in your 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 realm/SwiftLint
- mint run JohnSundell/Marathon
- mint run yonaskolb/XcodeGen
- mint run yonaskolb/SwagGen
- mint run Carthage/Carthage
- mint run krzysztofzablocki/Sourcery
- mint run toshi0383/cmdshelf
Feel free to add your own!
Help us keep the lights on
0.7.1 - Jan 6, 2018
- add backwards compatibility for
mint runcalls still using quotes
- don't log error message from mint if run executable fails
0.7.0 - Jan 6, 2018
updatenow link the executable to
usr/local/binby default, for global usage. Disable this with
--global:false#41 #44 #45
- arguments to an executable no longer have to be surrounded in quotes.
mint run yonaskolb/xcodegen xcodegen --spec myspec.yml
- added streaming of run command output #36
--verboseflag for cloning and building output #36
- fixed ANSI color issue #36
- replaced ShellOut with SwiftShell #36
- added a whole bunch of tests
0.6.1 - Dec 1, 2017
- Fixed calculation of latest version #30
- Integrated SwiftPM for versioning, more integrations will follow #30
0.6.0 - Nov 30, 2017
- Fixed issues on case‐sensitive file systems #19 @SDGGiesbrecht
- Fixed updating branches and packages without checked in
- Package repos are now checked out fresh on each install #24
- If not passing a version, tags are now fetched remotely #24
- Clones are now shallow #28
mint listcommand for listing all installed package versions #25
0.5.0 - Oct 13, 2017
- BREAKING: Changed version from the second argument to an @ suffix on the repo