Installation

Installing Clockwork is quick and easy, and should take less than a few seconds. The install script is the fastest way to set it up, it handles downloading the binary for your platform and adding it to the path.

Windows

Run this command in Powershell (as Administrator):

Invoke-WebRequest -Uri https://raw.githubusercontent.com/Turtlepaw/clockwork/refs/heads/main/install/install.ps1 -UseBasicParsing | Invoke-Expression

⚠️

You must run the script as Administrator or it will fail.

Custom Installation Path

Beta

You can set a custom installation, replacing C:\Your\Desired\Path with your desired path:

$scriptContent = (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/Turtlepaw/clockwork/refs/heads/main/install/install.ps1" -UseBasicParsing).Content
Invoke-Command -ScriptBlock ([ScriptBlock]::Create($scriptContent)) -ArgumentList @("C:\Your\Desired\Path")

⚠️

It’s highly recommended to use the default path as there may be issues with the script if you use a custom path.

Linux/MacOS

curl -s https://raw.githubusercontent.com/Turtlepaw/clockwork/refs/heads/main/install/install.sh | sudo bash

This script will download the latest release of Clockwork and add it to your path.

Manual installation of files in wff-build-tools is no longer required

Default Download Locations

Operating System	Path
Microsoft Windows	`%USERPROFILE%\Clockwork`
Linux	`/usr/local/bin`

⚠️

Mac OS is currently not officially supported, but you may be able to use the Linux script.

Obtaining Clockwork’s installation directory

which clockwork

Uninstalling Clockwork

We’re sad to see you go, if you have encountered any issues, please open an issue.

Delete the installation folder

rm "$CLOCKWORK_HOME"

Remove environment variables

Clockwork sets 2 environment variables:

CLOCKWORK_HOME
PATH

You will have to remove/modify them manually. An easy way to edit environment variables on Windows is Microsoft Powertoys.

Introduction Installing Packages