
Overmind CLI
π₯ Watch a demo | π Docs | π Sign up | π Follow us
What is Overmind?
Overmind is a tribal knowledge database that empowers your team to manage infrastructure confidently, even without extensive experience.
Signs your team needs Overmind
-
Blocked Experts & Slow Onboarding
- Expert team members spend too much time on approvals, reducing overall productivity.
- Newer staff face a steep learning curve, delaying their effectiveness.
-
Limited Dependency Visibility
- Tools like Terraform show intended changes but don't reveal underlying dependencies.
- Difficulty in assessing whether changes will disrupt existing applications.
-
Complex Outage Troubleshooting
- Pinpointing issues during outages is challenging due to hidden dependencies.
- Outages often result from intricate, unforeseen relationships rather than simple cause-and-effect.
Quick Start
Install the Overmind CLI using brew:
brew install overmindtech/overmind/overmind-cliLaunch the assistant and explore your newly configured AWS source:
overmind exploreRun a terraform plan:
overmind terraform planInstall 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-cliWindows
Install using winget:
winget install Overmind.OvermindCLIOr manually download the latest release, extract overmind.exe, and add to your PATH
Ubuntu / Debian
Set up the repository automatically:
curl -1sLf \
'https://dl.cloudsmith.io/public/overmind/tools/setup.deb.sh' \
| sudo -E bashOr set it up manually
# NOTE: For Debian Stretch, Ubuntu 16.04 and later
keyring_location=/usr/share/keyrings/overmind-tools-archive-keyring.gpg
# NOTE: For Debian Jessie, Ubuntu 15.10 and earlier
keyring_location=/etc/apt/trusted.gpg.d/overmind-tools.gpg
# Capture the codename
codename=$(lsb_release -cs)
apt-get install -y debian-keyring # debian only
apt-get install -y debian-archive-keyring # debian only
apt-get install -y apt-transport-https
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
chmod 0644 /etc/apt/sources.list.d/overmind-tools.list
chmod 0644 /usr/share/keyrings/overmind-tools-archive-keyring.gpg
apt-get updateThen install the CLI:
apt-get install overmind-cliRHEL
Set up the repository automatically:
curl -1sLf \
'https://dl.cloudsmith.io/public/overmind/tools/setup.rpm.sh' \
| sudo -E bashOr 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-cliAlpine
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 bashOr set it up manually
curl -1sLf 'https://dl.cloudsmith.io/public/overmind/tools/rsa.7B6E65C2058FDB78.key' > /etc/apk/keys/tools@overmind-7B6E65C2058FDB78.rsa.pub
curl -1sLf 'https://dl.cloudsmith.io/public/overmind/tools/config.alpine.txt?distro=alpine&codename=v3.8' >> /etc/apk/repositories
apk updateThen install the CLI:
apk add overmind-cliArch
Packages for Arch are available on the releases page for manual download and installation.
Additionally a community maintained package can be found in the aur.
ASDF
Overmind can be installed using asdf:
# Add the plugin
asdf plugin add overmind-cli https://github.com/overmindtech/asdf-overmind-cli.git
# Show all installable versions
asdf list-all overmind-cli
# Install specific version
asdf install overmind-cli latest
# Set a version globally (on your ~/.tool-versions file)
asdf global overmind-cli latest
# Now overmind-cli commands are available
overmind --versionDiscover CLI Commands
-
overmind exploreOvermind Assistant is a chat assistant that has real-time access to all your
AWS, GCP and K8S infrastructure. It alleviates the mental exhaustion of
manual troubleshooting, simplifies incident resolution by easily accessing
historical data, and automates time-consuming tasks such as documentation
and Terraform code generation. You can access the assistant by running
overmind explore. -
overmind terraform plan / applyOvermind can identify the blast radius and uncover potential risks with
overmind terraform planbefore they harm your infrastructure, allowing
anyone to make changes with confidence. It can also track the impact of the
changes you make withovermind terraform apply, so that you can be sure
that your changes haven't had any unexpected downstream impact.
Cloud Provider Support
The CLI automatically discovers AWS and GCP providers from your Terraform configuration.
How We Solve It?
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-approveThen 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-approveJoin the Community
- Join our Discord
- Contact us via email at sales@overmind.tech
- Follow us on LinkedIn
Additional Resources
Reporting Bugs
- Want to report a bug or request a feature? Open an issue
Development
Please look in the CONTRIBUTING.md document.
License
See the LICENSE file for licensing information.
Overmind is made with β€οΈ in πΊπΈπ¬π§π¦πΉπ«π·π·π΄
.gif)

