Skip to content

Commit f8b92e6

Browse files
committed
updated docs
1 parent b71e865 commit f8b92e6

File tree

3 files changed

+37
-23
lines changed

3 files changed

+37
-23
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
| Command | Description |
1919
|------------------------|--------------------------------------------|
20-
| `devolv validate file` | Validate AWS IAM policies (✅ live) |
20+
| `devolv validate` | Validate AWS IAM policies (✅ live) |
2121
| `devolv scan` | 🔜 Scan AWS accounts (coming soon) |
2222
| `devolv generate` | 🧠 Generate safe IAM policies (coming soon)|
2323
| `devolv etl` | ⚙️ CI/CD IAM transformation (planned) |

docs/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
## 🚀 Why Devolv?
88

9-
- Prevent security risks in IAM policies
10-
- Automate least-privilege generation
11-
- Enable continuous IAM validation in CI/CD
9+
- Prevent security risks in IAM policies
10+
- Automate least-privilege generation
11+
- Enable continuous IAM validation in CI/CD
1212
- All via one CLI interface: `devolv`
1313

1414
---
@@ -23,12 +23,13 @@ pip install devolv
2323

2424
## 🔍 What Can It Do?
2525

26-
| Command | Description |
27-
|------------------------|----------------------------------------------|
28-
| `devolv validate file` | Validate AWS IAM JSON/YAML files |
29-
| `devolv scan` | 🔜 Scan AWS accounts and misconfigurations |
30-
| `devolv generate` | 🧠 AI/Rule-based IAM policy generation |
31-
| `devolv etl` | 🔄 Transform/clean policies in pipelines |
26+
| Command | Status | Description |
27+
|--------------------------|----------|----------------------------------------------------|
28+
| `devolv validate file` | ✅ Ready | Validate a single AWS IAM JSON/YAML policy file |
29+
| `devolv validate folder` | ✅ Ready | Validate all policies inside a folder |
30+
| `devolv scan` | 🔜 WIP | Scan AWS accounts for live misconfigurations |
31+
| `devolv generate` | 🔜 WIP | AI/Rule-based IAM policy generation |
32+
| `devolv etl` | 🔜 WIP | Transform/clean policies for IAM pipelines |
3233

3334
---
3435

@@ -37,4 +38,3 @@ pip install devolv
3738
- [Validator CLI](./validator.md)
3839
- [Roadmap](./roadmap.md)
3940
- [GitHub Repo](https://github.com/devolvdev/devolv)
40-

docs/validator.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# `devolv validate file`
1+
# `devolv validate`
22

3-
This is the first released module of Devolv.
3+
This is the **first released module** of **Devolv** — the Modular DevOps CLI Toolkit.
44

55
---
66

77
## 🛡 Purpose
88

9-
Statically validate AWS IAM policy files for:
9+
Statically validate AWS IAM policy files to detect:
1010

11-
- ✅ Wildcards in Action or Resource
12-
- 🔐 `iam:PassRole` misuse
13-
- 🚨 Common escalation risks
11+
- ✅ Wildcards in Action (`*`, `s3:*`)
12+
- 🔐 `iam:PassRole` with wildcard resources
13+
- 🚨 Common privilege escalation risks
1414

1515
---
1616

17-
## 📂 Supported Input
17+
## 📂 Supported Input Formats
1818

1919
- `.json`
2020
- `.yaml` / `.yml`
@@ -23,14 +23,26 @@ Statically validate AWS IAM policy files for:
2323

2424
## 🔧 Usage
2525

26+
### 🔹 Validate a Single File
27+
2628
```bash
2729
devolv validate file path/to/policy.json
2830
```
2931

32+
### 🔹 Validate a Folder
33+
34+
```bash
35+
devolv validate folder path/to/folder/
36+
```
37+
38+
> Scans all `.json`, `.yaml`, and `.yml` files in the folder recursively.
39+
3040
---
3141

3242
## 📋 Example
3343

44+
### Input File: `policy.json`
45+
3446
```json
3547
{
3648
"Version": "2012-10-17",
@@ -44,17 +56,19 @@ devolv validate file path/to/policy.json
4456
}
4557
```
4658

47-
Output:
59+
### Output
4860

4961
```
5062
❌ HIGH: Policy uses wildcard in Action, which is overly permissive.
63+
❌ HIGH: iam:PassRole with wildcard resource can lead to privilege escalation.
5164
```
5265

5366
---
5467

5568
## ✅ Exit Codes
5669

57-
- `0`: All checks passed
58-
- `1`: Risk found in policy
59-
- `2`: File or format error
60-
70+
| Code | Meaning |
71+
|------|-----------------------------|
72+
| `0` | All checks passed |
73+
| `1` | Risk found in policy |
74+
| `2` | File/folder not found or invalid format |

0 commit comments

Comments
 (0)