Installation

Wake requires Python 3.8 or higher.

Warning

Python 3.12 is experimentally supported.

Using pip

pip3 install eth-wake

Together with VS Code extension

eth-wake is automatically installed with the Tools for Solidity extension.

Docker image

Wake is also available as a Docker image:

docker pull ackeeblockchain/wake
docker run -it ackeeblockchain/wake wake --help

Github actions

Wake comes with 2 Github actions:

• Ackee-Blockchain/wake-setup-action - sets up a CI pipeline with Wake and Anvil pre-installed
• Ackee-Blockchain/wake-detect-action - runs detectors with optional SARIF output

Shell completions

It is possible to enable shell completions for the wake command (does not apply to wake-solc). The instructions depend on the shell you are using.

BashZshFish

Add the following to your ~/.bashrc file:

eval "$(_WAKE_COMPLETE=bash_source wake)"

Add the following to your ~/.zshrc file:

eval "$(_WAKE_COMPLETE=zsh_source wake)"

Add the following to your ~/.config/fish/completions/wake.fish file:

eval (env _WAKE_COMPLETE=fish_source wake)