Skip to content

Commit e75d18e

Browse files
Update README.md (#594)
* Update README.md This adds reference to the release of the new assistant along with some other tweaks Co-authored-by: Dylan <dylan@overmind.tech>
1 parent 8bce06c commit e75d18e

File tree

1 file changed

+31
-6
lines changed

1 file changed

+31
-6
lines changed

README.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,23 @@
1515

1616
# What is Overmind?
1717

18-
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.
18+
Overmind is a **tribal knowledge database** that empowers your team to manage infrastructure confidently, even without extensive experience.
19+
20+
### Signs your team needs Overmind
21+
22+
- **Blocked Experts & Slow Onboarding**
23+
24+
- Expert team members spend too much time on approvals, reducing overall productivity.
25+
- Newer staff face a steep learning curve, delaying their effectiveness.
26+
27+
- **Limited Dependency Visibility**
28+
29+
- Tools like Terraform show intended changes but don't reveal underlying dependencies.
30+
- Difficulty in assessing whether changes will disrupt existing applications.
31+
- **Complex Outage Troubleshooting**
32+
33+
- Pinpointing issues during outages is challenging due to hidden dependencies.
34+
- Outages often result from intricate, unforeseen relationships rather than simple cause-and-effect.
1935

2036
# Quick Start
2137

@@ -25,6 +41,12 @@ Install the Overmind CLI using brew:
2541
brew install overmindtech/overmind/overmind-cli
2642
```
2743

44+
Launch the assistant and explore your newly configured AWS source:
45+
46+
```shell
47+
overmind explore
48+
```
49+
2850
Run a terraform plan:
2951

3052
```shell
@@ -159,12 +181,15 @@ Additionally a community maintained package can be found in the [aur](https://au
159181

160182
</details>
161183

162-
## Why Use Overmind?
184+
**Discover CLI Commands**
163185

164-
- **☁️ 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.
165-
- **👨‍🏫 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.
166-
- **📋 Change Management Process:** IaC and automation mean that changes spend substantially more time in review and approval steps than the change itself actually takes.
167-
- **🔥 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.
186+
- `overmind explore`
187+
188+
Overmind Assistant is a chat assistant that has real-time access to all your AWS and K8’s 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` .
189+
190+
- `overmind terrafrom plan / apply`
191+
192+
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. It can also track the impact 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.
168193

169194
## How We Solve It?
170195

0 commit comments

Comments
 (0)