Clone or download
Latest commit d61e7fd Jun 11, 2018
Failed to load latest commit information.
Sources Check command Jun 12, 2018
.gitignore Swift 3 Oct 23, 2016
.swift-version Update Travis Jun 12, 2018
.travis.yml Brew update Jun 12, 2018
LICENSE Create LICENSE Oct 31, 2016
Package.resolved Combine Flock and FlockCLI Jun 12, 2018
Package.swift Combine Flock and FlockCLI Jun 12, 2018
README.md Update README Jun 12, 2018



Automated deployment of Swift projects to servers. Once set up, deploying your project is as simple as:

> flock deploy

Flock will clone your project onto your server(s), build it, and start the application (and do anything else you want it to do). Flock already works great with Vapor, Zewo, Perfect, and Kitura.

Inspired by Capistrano.

Table of Contents


Mint (recommended)

mint install jakeheis/Flock


git clone https://github.com/jakeheis/Flock
cd Flock
swift build -c release
mv .build/release/flock /usr/bin/local/flock


To start using Flock, run:

flock init

This command creates a Flock.swift file in the current directory. After the command completes, you should read through Flock.swift and follow the directions located throughout the file.


Running tasks

You can see the available tasks by running flock with no arguments. To run a task, just call flock <task>, such as:

flock deploy # Run the deploy task

You can also specify the environment Flock should execute the task in:

flock deploy --env=production # Same as just running flock deploy
flock deploy --env=staging # Run the deploy task in the staging environment

Writing your own tasks

See the note in Flock.swift about how to write your own task. Your task will ultimately run some commands on a Server object. Here are some examples of what's possible:

try server.execute("mysql -v") // Execute a command remotely

let contents = try server.capture("cat myFile") // Execute a command remotely and capture the output

// Execute all commands in this closure within Path.currentDirectory
try server.within(Path.currentDirectory) {
    try server.execute("ls")
    if server.fileExists("anotherFile.txt") { // Check the existence of a file on the server
        try server.execute("cat anotherFile.txt")

Check out Server.swift to see all of Server's available methods. Also take a look at Paths.swift to see the built-in paths for your server.within calls.


In general, you should create a dedicated deploy user on your server. Authentication & Authorisation is a great resource for learning how to do this.

To ensure the deploy task succeeds, make sure:

  • The deploy user has access to Config.deployDirectory (default /var/www)
  • The deploy user has access to the swift executable

Some additional considerations if you plan to use supervisord (which you likely should!):