You can install Crank in a variety of ways. Given that it's a command-line tool, we recommend you use the CLI to install it. If you'd prefer, packaged installers are also provided for Windows and macOS.
Standalone Installation
The simplest way to install Crank is via the command line. To quickly set up
into /usr/local/lib/crank and /usr/local/bin/crank, run this script.
# On macOS or Linux
$ curl -s https://get.crank.run/install.sh | sh
Note: this script requires sudo and is not Windows compatible.
Packaged Installers
If you're running Windows or you're running macOS and prefer to install Crank via a packaged installer, use the following:
Note: the packages are currently unsigned, so you may need to explicitly allow them or trust them in your system preferences / security & privacy settings.
Visual Studio Code
For the best Scenario authoring experience, we highly recommend using Visual Studio Code and installing the Crank Scenario Language extension.
Updating Crank
$ crank update
Crank will automatically attempt to update itself in the background. You can
also run crank update to explicitly update to the latest version.
Uninstalling Crank
On macOS, you can uninstall the CLI by typing:
$ rm -rf /usr/local/crank \
/usr/local/lib/crank \
/usr/local/bin/crank \
~/.local/share/crank \
~/Library/Caches/crank
On Linux, you can uninstall the CLI by typing:
$ rm /usr/local/bin/crank
$ rm -rf /usr/local/lib/crank /usr/local/crank
$ rm -rf ~/.local/share/crank ~/.cache/crank
On Windows, to uninstall Crank:
- Click Start > Control Panel > Programs > Programs and Features.
- Select Crank CLI, and then click Uninstall. Note that the uninstaller is unsigned.
If this is unsuccessful, manually delete %LOCALAPPDATA%\crank along with the directory in Program Files.