Detect non-inclusive language in your source code.

Project maintained by Caitlin Elfring Hosted on GitHub Pages — Theme by mattgraham

I stay woke - Erykah Badu



Creating an inclusive work environment is imperitive to a healthy, supportive, and productive culture, and an environment where everyone feels welcome and included.

woke’s purpose is to point out places where improvements can be made by removing non-inclusive language and replacing it with more inclusive alternatives.

Companies like GitHub, Twitter, and Apple are already pushing these changes.


Install the latest version of woke


You can install a binary release on macOS using brew

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


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.


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


Download the latest binary from Releases


$ woke --help

woke is a linter that will check your source code for usage of non-inclusive
language and provide suggestions for alternatives. Rules can be customized
to suit your needs.

Provide a list file globs for files you'd like to check.

  woke [globs ...] [flags]

  -c, --config string       Config file (default is .woke.yaml in current directory, or $HOME)
      --debug               Enable debug logging
      --exit-1-on-failure   Exit with exit code 1 on failures
  -h, --help                help for woke
      --no-ignore           Ignored files in .gitignore/.wokeignore and inline ignores are processed
  -o, --output string       Output type [text,simple,github-actions,json] (default "text")
      --stdin               Read from stdin
  -v, --version             version for woke



More Info

Learn more about woke at https://github.com/get-woke/woke


This application is licensed under the MIT License, you may obtain a copy of it here.