Install¶

cfnrain is one static binary. Download a release archive, or build it with Go. In GitHub Actions, use the install action.

GitHub Actions¶

The install-cfnrain action installs cfnrain on Linux, macOS and Windows runners. Before the install, it verifies the checksum and the build provenance:

- uses: awesome-foundation/install-cfnrain@v1
  with:
    version: 1.25.2

The README of the action lists its inputs and outputs. CI usage shows complete workflows.

Release archives¶

Each release has archives for Linux, macOS and Windows:

The archive name is cfnrain_<version>_<os>_<arch>, for example cfnrain_1.25.2_linux_amd64.tar.gz. Each archive contains cfnrain, LICENSE, NOTICE and README.md. Each release also has a checksums.txt file.

Download an archive and the checksum file. This example uses the GitHub CLI:

VERSION=1.25.2
gh release download "v${VERSION}" -R awesome-foundation/cfnrain \
  -p "cfnrain_${VERSION}_linux_amd64.tar.gz" -p checksums.txt

You can also download them from the release page with a browser or curl.

Verify the checksum¶

checksums.txt lists the SHA-256 checksum of every archive. Check the archive that you downloaded:

sha256sum --ignore-missing -c checksums.txt

The output must say OK for your archive. On macOS, use shasum -a 256 --ignore-missing -c checksums.txt.

Verify the provenance¶

The release workflow attests the build provenance of every archive. The attestation proves that the archive was built by the cfnrain release workflow from this repository. Verify it with the GitHub CLI:

gh attestation verify "cfnrain_${VERSION}_linux_amd64.tar.gz" -R awesome-foundation/cfnrain

Install the binary¶

tar -xzf "cfnrain_${VERSION}_linux_amd64.tar.gz" cfnrain
sudo install cfnrain /usr/local/bin/cfnrain
cfnrain --version

cfnrain --version prints the version, the OS and the architecture, for example cfnrain v1.25.2 linux/amd64.

Install with Go¶

If you have Go installed, build and install the latest release:

go install github.com/awesome-foundation/cfnrain/cmd/cfnrain@latest

Go puts the binary in $(go env GOPATH)/bin. Make sure that this directory is on your PATH.

Homebrew¶

There is no Homebrew formula yet. Follow issue #14 for progress.

Keep the rain name¶

Scripts that call rain keep working when you link the name to cfnrain:

ln -s "$(command -v cfnrain)" /usr/local/bin/rain

You can use any directory on your PATH. Shell completion can complete both names.

Shell completion¶

cfnrain completion prints a completion script for bash, zsh, fish or PowerShell. cfnrain completion <shell> --help shows more ways to install it.

# bash: add this line to ~/.bashrc
source <(cfnrain completion bash)

# zsh: add this line to ~/.zshrc, after compinit
source <(cfnrain completion zsh)

# fish
cfnrain completion fish > ~/.config/fish/completions/cfnrain.fish

If you linked rain to cfnrain, add a second line to complete that name too:

# bash
complete -o default -F __start_cfnrain rain

# zsh
compdef _cfnrain rain

AWS credentials¶

cfnrain uses the standard AWS SDK credential chain: environment variables, the shared config and credentials files, SSO, and instance or container roles. Use -p or --profile to pick a profile and -r or --region to pick a region.

Check which account and region cfnrain uses:

cfnrain info