Skip to content

Installation

Tip

There are multiple ways to install woke. If you're interested in any installation methods that are not listed here, feel free to open an issue.

Releases

Download the latest binary from Releases

macOS

You can install a binary release on macOS using brew

brew install get-woke/tap/woke
brew upgrade get-woke/tap/woke

Windows

You can install woke with scoop

scoop bucket add get-woke https://github.com/get-woke/scoop-bucket.git
scoop install get-woke/woke

Simple installation

To install the latest version:

curl -sSfL https://git.io/getwoke | \
  bash -s -- -b /usr/local/bin

Or install a specific version (omit the minor or patch portion to install the latest major/minor version)

curl -sSfL https://git.io/getwoke | \
  bash -s -- -b /usr/local/bin v0.9.0

Feel free to change the path from /usr/local/bin, just make sure woke is available on your $PATH (check with woke --version).

Build from source

Install the go toolchain: https://golang.org/doc/install

go get -u github.com/get-woke/woke

woke will be installed to $GOPATH/bin/woke.

Docker

You can run woke within docker. You will need to mount a volume that contains your source code and/or rules.

## Run with all defaults, within the mounted /src directory
docker run -v $(pwd):/src -w /src getwoke/woke

## Provide rules config
docker run -v $(pwd):/src -w /src getwoke/woke \
  woke -c my-rules.yaml

CI

GitHub Actions

Others

Are there other CI systems that you're using to run woke? Edit this page and add documentation/configurations for others.


Last update: 2021-11-27
Back to top