Skip to content

Commit 3844005

Browse files
committed
:happy: updated readme
1 parent 7a38327 commit 3844005

1 file changed

Lines changed: 37 additions & 21 deletions

File tree

README.md

Lines changed: 37 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,38 @@
1-
# devolv-validator
1+
# devolv
22

33
[![PyPI - Version](https://img.shields.io/pypi/v/devolv)](https://pypi.org/project/devolv/)
44
[![Tests](https://github.com/devolvdev/devolv/actions/workflows/test.yml/badge.svg)](https://github.com/devolvdev/devolv/actions)
55
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
66

7-
**devolv-validator** is a subtool of the [**Devolv** OSS DevOps Toolkit](https://github.com/devolvdev).
8-
It statically validates AWS IAM policies (JSON or YAML) for risky patterns such as wildcards, privilege escalation, and misconfigurations.
7+
**Devolv** is a modular DevOps toolkit built for secure-by-default cloud infrastructure.
8+
Install once — and unlock a growing set of powerful CLI tools designed to improve cloud security, automation, and IAM hygiene.
99

1010
---
1111

12-
## 🚀 Features
12+
## 🧰 Available Tools
1313

14-
- 🚩 Detects wildcards in `Action` and `Resource`
15-
- 🔐 Flags `iam:PassRole` with wildcard `Resource`
16-
- 📂 Supports both JSON and YAML input
17-
- ⚙️ Simple CLI using [Typer](https://typer.tiangolo.com/)
18-
- ✅ CI-ready with GitHub Actions
14+
| Command | Description |
15+
|------------------------|----------------------------------------------|
16+
| `devolv validate file` | Validate AWS IAM policies statically |
17+
18+
19+
> All tools are accessible through the single CLI entrypoint: `devolv`
1920
2021
---
2122

22-
## 📦 Installation
23+
## 🔐 IAM Validator (Live Now)
24+
25+
`devolv validate file` statically analyzes AWS IAM policies for:
26+
27+
- 🚩 Wildcards in `Action` and `Resource`
28+
- 🔐 `iam:PassRole` without restriction
29+
- ⚠️ Common privilege escalation patterns
30+
31+
Supports both `.json` and `.yaml` input formats.
32+
33+
---
2334

24-
Install the full Devolv toolkit:
35+
## 📦 Installation
2536

2637
```bash
2738
pip install devolv
@@ -35,9 +46,15 @@ pip install devolv
3546
devolv validate file path/to/policy.json
3647
```
3748

49+
Example output:
50+
51+
```
52+
❌ HIGH: Policy uses wildcard in Action, which is overly permissive.
53+
```
54+
3855
---
3956

40-
## 📁 Example
57+
## 📁 Example Policy
4158

4259
```json
4360
{
@@ -52,8 +69,6 @@ devolv validate file path/to/policy.json
5269
}
5370
```
5471

55-
This will be flagged as high-risk due to overly permissive wildcards.
56-
5772
---
5873

5974
## 🧪 Run Tests
@@ -64,14 +79,15 @@ pytest
6479

6580
---
6681

67-
## 🧰 About
82+
## 👀 Follow the Journey
6883

69-
This tool is part of the [Devolv OSS Toolkit](https://github.com/devolvdev), a growing collection of DevOps-first security and automation tools.
84+
Devolv is built in public — one CLI tool at a time.
85+
More tools, community features, and integrations are coming soon.
7086

71-
Follow the repo for upcoming modules like:
72-
73-
- `devolv scan`: analyze AWS infrastructure
74-
- `devolv generate`: produce IAM policies safely
75-
- `devolv etl`: secure CI/CD for policy transformation
87+
- 🐍 PyPI: [devolv](https://pypi.org/project/devolv)
88+
- 🔗 GitHub: [github.com/devolvdev](https://github.com/devolvdev)
89+
- 🐦 Twitter/X: [@Devolv__](https://x.com/Devolv__)
7690

7791
---
92+
93+
> Built for cloud engineers. Backed by open-source. Shipped with love.

0 commit comments

Comments
 (0)