sysl is a command-line tool written in Go. There are a variety of ways to install it, depending on your OS and use case.
$ brew install anz-bank/homebrew-sysl/sysl
$ docker run --rm -it -v $HOME:$HOME -w $(pwd) anzbank/sysl:latest
$ GO111MODULE=on go get -u github.com/anz-bank/sysl/cmd/sysl
$ git clone https://github.com/anz-bank/sysl.git, then
$ make install
- Binary: download from the GitHub releases page to your
Check the installation with
If you use a Mac and have Homebrew installed, you can simply run the following commands in your terminal:
Download the pre-compiled binaries matching your OS from the releases page.
Uncompress the archive and move the
syslbinary to your desired location:
- On your
PATHto run it with
- Elsewhere to run it with
./sysl, or some other
- On your
Go get it
First make sure you've installed Go:
sysl command's Go module:
Do NOT run this from inside a Go source directory that is module enabled, otherwise it gets added to go.mod/go.sum.
Mac and Linux users can create an
alias for the
sysl can then be used from the same terminal window. Alternatively, add the
alias to your
.zshrc file to keep it permanently.
Compile from source
Here you have two options:
- If you want to contribute to the project, please follow the steps on our contributing guide.
- If just want to build from source, follow the steps below:
Try it out
If the installation worked, you should be able to run:
You can always check yours setup of
VS Code Extension
Sysl has a VS Code extension which provides syntax highlighting for
.sysl files. Get it from here, or search Extensions for "sysl".