Marathon makes it easy to write, run and manage your Swift scripts πŸƒ
Swift Other
Switch branches/tags
Nothing to show

README.md

Marathon

Travis status Swift Package Manager Twitter: @johnsundell

Welcome to Marathon, a command line tool that makes it easy to write, run and manage your Swift scripts. It's powered by the Swift Package Manager and requires no modification to your existing scripts or dependency packages.

Features

🐣 Create scripts

$ marathon create helloWorld "import Foundation; print(\"Hello world\")"

πŸƒβ€β™€οΈ Run scripts

$ marathon run helloWorld
> Hello world

πŸ“¦ Hassle free dependency management. Simply add a package...

$ marathon add https://github.com/JohnSundell/Files.git

...and use it without any additional work

import Files

for file in try Folder(path: "MyFolder").files {
    print(file.name)
}

πŸš€ Update all of your scripting dependencies with a single call

$ marathon update

βš’ Edit, run & debug your scripts using Xcode...

$ marathon edit helloWorld

...or in your favorite text editor

$ marathon edit helloWorld --no-xcode

🌍 Run remote scripts directly from a Git repository...

$ marathon run https://github.com/johnsundell/testdrive.git

...using only a GitHub username & repository name:

$ marathon run johnsundell/testdrive

πŸ’» Install scripts as binaries and run them independently from anywhere...

$ marathon install helloWorld
$ helloWorld
> Hello world

...you can even install remote scripts (+ their dependencies) from a URL:

$ marathon install https://raw.githubusercontent.com/JohnSundell/Marathon-Examples/master/AddSuffix/addSuffix.swift
$ cd myImages
$ addSuffix "@2x"
> Added suffix "@2x" to 15 files

...or from a GitHub repository:

$ marathon install johnsundell/testdrive
$ testdrive

πŸ‘ͺ Share your scripts with your team and automatically install their dependencies...

import Files // marathon:https://github.com/JohnSundell/Files.git

print(Folder.current.path)

...or specify your dependencies using a Marathonfile:

$ echo "https://github.com/JohnSundell/Files.git" > Marathonfile

Installing

On macOS

Using Homebrew:

brew install marathon-swift

Using Mint:

$ mint run JohnSundell/Marathon

Using Make:

$ git clone https://github.com/JohnSundell/Marathon.git
$ cd Marathon
$ make

Using the Swift Package Manager:

$ git clone https://github.com/JohnSundell/Marathon.git
$ cd Marathon
$ swift build -c release -Xswiftc -static-stdlib
$ cp -f .build/release/Marathon /usr/local/bin/marathon

On Linux

$ git clone https://github.com/JohnSundell/Marathon.git
$ cd Marathon
$ swift build -c release
$ cp -f .build/release/Marathon /usr/local/bin/marathon

If you encounter a permissions failure while installing, you may need to prepend sudo to the commands. To update Marathon, simply repeat any of the above two series of commands, except cloning the repo.

Requirements

Marathon requires the following to be installed on your system:

  • Swift 3.1 or later (bundled with Xcode 8.3 or later)
  • Git
  • Xcode (if you want to edit scripts using it)

Examples

Check out this repository for a few example Swift scripts that you can run using Marathon.

Specifying dependencies inline

Scripting usually involves using 3rd party frameworks to get your job done, and Marathon provides an easy way to define such dependencies right when you are importing them in your script, using a simple comment syntax:

import Files // marathon:https://github.com/JohnSundell/Files.git
import Unbox // marathon:https://github.com/JohnSundell/Unbox.git

Specifying your dependencies ensures that they will always be installed by Marathon before your script is run, edited or installed - making it super easy to share scripts with your friends, team or the wider community. All you have to do is share the script file, and Marathon takes care of the rest!

Using a Marathonfile

If you prefer to keep your dependency declarations separate, you can create a Marathonfile in the same folder as your script. This file is simply a new line separated list of URLs pointing to either:

  • The URL to a git repository of a local or remote package to install before running your script.
  • The path to another script that should be linked to your script before running it.

Here is an example of a Marathonfile:

https://github.com/JohnSundell/Files.git
https://github.com/JohnSundell/Unbox.git
https://github.com/JohnSundell/Wrap.git
~/packages/MyPackage
otherScript.swift

Using Marathon with Swift 4

Marathon supports writing scripts using Swift 4 and the Xcode 9 beta. To do this you'll need to switch your Xcode command line tools to use the Xcode 9 beta using xcode-select, like this:

$ sudo xcode-select -s /Applications/Xcode-beta.app/Contents/Developer/

If you've installed the Xcode 9 beta at some other path than the one above, simply switch out the path when running the command.

Important note: Doing the above will switch your Xcode command line tools to Xcode 9 beta across your entire system, which may cause problems with other tooling that relies on the latest stable version of Xcode. If you encounter any such problems and want to switch back, you simply run xcode-select again to return to the latest stable version of Xcode:

$ sudo xcode-select -s /Applications/Xcode.app/Contents/Developer/

Shell autocomplete

Marathon includes autocomplete for the zsh and fish shells (PRs adding support for other shells is more than welcome!). To enable it, do the following:

  • zsh:

    • Add the line fpath=(~/.marathon/ShellAutocomplete/zsh $fpath) to your ~/.zshrc file.
    • Add the line autoload -Uz compinit && compinit -i to your ~/.zshrc file if it doesn't already contain it.
    • Restart your terminal.
  • fish:

    • cp -f ~/.marathon/ShellAutocomplete/fish/marathon.fish ~/.config/fish/completions

You can now type marathon r and have it be autocompleted to marathon run πŸŽ‰

Help, feedback or suggestions?

  • Run $ marathon help to display help for the tool itself or for any specific command.
  • Append --verbose to any command to make Marathon output everything it's doing, for debugging purposes.
  • Open an issue if you need help, if you found a bug, or if you want to discuss a feature request.
  • Open a PR if you want to make some change to Marathon.
  • Contact @johnsundell on Twitter for discussions, news & announcements about Marathon.