# README
Overmind CLI
🎥 Watch a demo | 📖 Docs | 🚀 Sign up | 💻 Playground | 🙌 Follow us
What is Overmind?
Overmind is a powerful tool for real-time impact analysis on Terraform changes. Overmind can identify the blast radius and uncover potential risks with overmind terrafrom plan before they harm your infrastructure, allowing anyone to make changes with confidence. We also track the impacts of the changes you make with overmind teraform apply, so that you can be sure that your changes haven't had any unexpected downstream impact.
Quick Start
Install the Overmind CLI using brew:
brew install overmindtech/overmind/overmind-cli
Run a terraform plan:
overmind terraform plan
.gif)
Install on other platforms
Prerequisites
- Terraform environment set up
- Access to all required credentials
- Ability to install and run the Overmind CLI
Installation
MacOS
To install on Mac with homebrew use:
brew install overmindtech/overmind/overmind-cli
Windows
Debian
Set up the repository automatically:
curl -1sLf \
'https://dl.cloudsmith.io/public/overmind/tools/setup.deb.sh' \
| sudo -E bash
Or set it up manually
apt-get install -y debian-keyring # debian only
apt-get install -y debian-archive-keyring # debian only
apt-get install -y apt-transport-https
# For Debian Stretch, Ubuntu 16.04 and later
keyring_location=/usr/share/keyrings/overmind-tools-archive-keyring.gpg
# For Debian Jessie, Ubuntu 15.10 and earlier
keyring_location=/etc/apt/trusted.gpg.d/overmind-tools.gpg
curl -1sLf 'https://dl.cloudsmith.io/public/overmind/tools/gpg.BC5CDEFB4E37A1B3.key' | gpg --dearmor >> ${keyring_location}
curl -1sLf 'https://dl.cloudsmith.io/public/overmind/tools/config.deb.txt?distro=ubuntu&codename=xenial&component=main' > /etc/apt/sources.list.d/overmind-tools.list
apt-get update
Then install the CLI:
apt-get install overmind-cli
RHEL
Set up the repository automatically:
curl -1sLf \
'https://dl.cloudsmith.io/public/overmind/tools/setup.rpm.sh' \
| sudo -E bash
Or set it up manually
yum install yum-utils pygpgme
rpm --import 'https://dl.cloudsmith.io/public/overmind/tools/gpg.BC5CDEFB4E37A1B3.key'
curl -1sLf 'https://dl.cloudsmith.io/public/overmind/tools/config.rpm.txt?distro=amzn&codename=2023' > /tmp/overmind-tools.repo
yum-config-manager --add-repo '/tmp/overmind-tools.repo'
yum -q makecache -y --disablerepo='*' --enablerepo='overmind-tools'
Then install the CLI:
sudo yum install overmind-cli
Alpine
Set up the repository automatically:
sudo apk add --no-cache bash
curl -1sLf \
'https://dl.cloudsmith.io/public/overmind/tools/setup.alpine.sh' \
| sudo -E bash
Or set it up manually
curl -1sLf 'https://dl.cloudsmith.io/public/overmind/tools/rsa.7B6E65C2058FDB78.key' > /etc/apk/keys/[email protected]
curl -1sLf 'https://dl.cloudsmith.io/public/overmind/tools/config.alpine.txt?distro=alpine&codename=v3.8' >> /etc/apk/repositories
apk update
Then install the CLI:
apk add overmind-cli
Arch
Packages for Arch are available on the releases page for manual download and installation.
Windows
Packages for Windows are available on the releases page for manual download and installation. Unpack the ZIP file and put the overmind.exe executable in your PATH.
Why Use Overmind?
- ☁️ Cloud Complexity: Terraform tells you what it's going to change, but not whether this change will break everything. Teams need to understand dependencies to properly understand impact.
- 👨🏫 Onboarding & Productivity: Due to the reliance on "tribal knowledge", expert staff are stuck doing approvals rather than productive work and newer staff take longer to become productive.
- 📋 Change Management Process: IaC and automation mean that changes spend substantially more time in review and approval steps than the change itself actually takes.
- 🔥 Downtime: Outages are not caused by simple cause-and-effect relationships. More often than not, downtime is a result of dependencies people didn't know existed.
How We Solve It?
 🔍 Blast Radius: Overmind maps out all potential dependencies and interactions within your infra in realtime. Supports over 120 AWS resources and all Kubernetes. |
 🚨 Risks: Discover specific risks that would be invisible otherwise. Risks are delivered directly to the pull request. Make deployment decisions within minutes not hours. |
Advanced Use
Passing Arguments
Overmind's overmind terraform plan and overmind terraform apply commands mostly just wrap the terraform that you already have installed, adding all of Overmind's features on top. This means that no matter how you're using Terraform today, this will still work with Overmind. For example if you're using a more complex command like:
terraform plan -var-file=production.tfvars -parallelism=20 -auto-approve
Then you would add overmind to the beginning, and your arguments after a double-dash e.g.
overmind terraform plan -- -var-file=production.tfvars -parallelism=20 -auto-approve
Join the Community
- Join our Discord
- Contact us via email at [email protected]
- Follow us on LinkedIn
Additional Resources
Reporting Bugs
- Want to report a bug or request a feature? Open an issue
License
See the LICENSE file for licensing information.
Overmind is made with ❤️ in 🇺🇸🇬🇧🇦🇹🇫🇷🇷🇴