Skip to content

Marathon makes it easy to write, run and manage your Swift scripts

License

Notifications You must be signed in to change notification settings

joseph-hurtado/Marathon

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Marathon

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 [email protected]: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

👪 Share your scripts with your team and automatically install their dependencies:

$ echo "[email protected]:JohnSundell/Files.git" > Marathonfile
$ marathon run mySharedScript

Installing

Using Make:

$ git clone [email protected]:JohnSundell/Marathon.git
$ cd Marathon
$ make

Using the Swift Package Manager:

$ git clone [email protected]:JohnSundell/Marathon.git
$ cd Marathon
$ swift build -c release -Xswiftc -static-stdlib
$ cp -f .build/release/Marathon /usr/local/bin/marathon

Using a Marathonfile

To easily be able to define depenencies for a script in a declarative way, 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 packages that should be installed before running the script. By doing this you can ensure that the required dependencies will be installed when sharing your script with team members, friends or the wider community.

Here is an example of a Marathonfile:

[email protected]:JohnSundell/Files.git
[email protected]:JohnSundell/Unbox.git
[email protected]:JohnSundell/Wrap.git

Help, feedback or suggestions?

  • Run $ marathon help to display help for the tool itself or for any specific command.
  • 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.

About

Marathon makes it easy to write, run and manage your Swift scripts

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Swift 99.7%
  • Makefile 0.3%