Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,4 @@ Desktop.ini
.env.*
*.pem
*.key
demo.cast
44 changes: 24 additions & 20 deletions README.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

**Trivy pour le gaspillage cloud. Un scanner qui détecte les ressources orphelines et applique l'hygiène en CI.**

![Démo CleanCloud](demo.gif)

Comme `tfsec` pour Terraform ou `trivy` pour les conteneurs — CleanCloud scanne votre environnement cloud et rapporte ce qui gaspille de l'argent. Exécutez-le une fois pour un audit ponctuel, planifiez-le, ou intégrez-le en CI/CD pour bloquer les builds sur des violations de politique.

- **20 règles de détection haut signal :** volumes orphelins, bases de données inactives, load balancers vides, et plus
Expand All @@ -27,7 +29,8 @@ Comme `tfsec` pour Terraform ou `trivy` pour les conteneurs — CleanCloud scann
- Analyses d'hygiène planifiées — cron ou CI hebdomadaire pour détecter la dérive
- Gate CI/CD — bloquer un build si le gaspillage dépasse votre seuil

```
```console
$ cleancloud scan --provider aws --all-regions
6 problèmes d'hygiène détectés :

1. [AWS] Volume EBS non attaché — $40/mois
Expand All @@ -53,20 +56,20 @@ Régions scannées : us-east-1, us-west-2, eu-west-1

## Démarrage

```bash
pipx install cleancloud
pipx ensurepath # ajoute cleancloud au PATH — relancez votre shell après
cleancloud demo # visualisez des findings sans aucun credential cloud
```console
$ pipx install cleancloud
$ pipx ensurepath # ajoute cleancloud au PATH — relancez votre shell après
$ cleancloud demo # visualisez des findings sans aucun credential cloud
```

Prêt à scanner votre vrai environnement ? Authentifiez-vous d'abord, puis lancez :

```bash
```console
# AWS : assurez-vous d'être connecté (aws configure, aws sso login, ou rôle IAM)
cleancloud scan --provider aws --all-regions
$ cleancloud scan --provider aws --all-regions

# Azure : assurez-vous d'être connecté (az login)
cleancloud scan --provider azure
$ cleancloud scan --provider azure
```

Pas sûr que vos credentials aient les bonnes permissions ? Lancez d'abord `cleancloud doctor --provider aws` ou `cleancloud doctor --provider azure`.
Expand All @@ -76,18 +79,18 @@ Pas sûr que vos credentials aient les bonnes permissions ? Lancez d'abord `clea
Vous avez un compte AWS ou Azure ? Lancez un vrai scan en quelques secondes, sans installation locale.

**AWS — [AWS CloudShell](https://console.aws.amazon.com/cloudshell) :**
```bash
pip install --upgrade cleancloud
cleancloud doctor --provider aws # vérifiez les permissions de votre session
cleancloud scan --provider aws --all-regions
```console
$ pip install --upgrade cleancloud
$ cleancloud doctor --provider aws # vérifiez les permissions de votre session
$ cleancloud scan --provider aws --all-regions
```

**Azure — [Azure Cloud Shell](https://shell.azure.com) :**
```bash
pip install --upgrade --user cleancloud
export PATH="$HOME/.local/bin:$PATH"
cleancloud doctor --provider azure # vérifiez les permissions de votre session
cleancloud scan --provider azure
```console
$ pip install --upgrade --user cleancloud
$ export PATH="$HOME/.local/bin:$PATH"
$ cleancloud doctor --provider azure # vérifiez les permissions de votre session
$ cleancloud scan --provider azure
```

Les deux shells s'authentifient via votre session du portail — aucune credential séparée n'est requise.
Expand Down Expand Up @@ -122,7 +125,8 @@ pip uninstall cleancloud && pipx install cleancloud && pipx ensurepath

## Exemple de résultat détaillé

```
```console
$ cleancloud scan --provider aws --all-regions
6 problèmes d'hygiène détectés :

1. [AWS] Volume EBS non attaché
Expand Down Expand Up @@ -170,8 +174,8 @@ Pas encore de compte cloud ? `cleancloud demo` affiche un exemple de sortie sans

### Rapport markdown partageable

```bash
cleancloud scan --provider aws --all-regions --output markdown
```console
$ cleancloud scan --provider aws --all-regions --output markdown
```

Produit un résumé groupé que vous pouvez coller directement dans un commentaire de PR GitHub, un message Slack, ou une issue :
Expand Down
44 changes: 24 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

**Trivy for cloud waste. A scanner that finds orphaned resources and enforces hygiene in CI.**

![CleanCloud demo](demo.gif)

Like `tfsec` for Terraform or `trivy` for containers — CleanCloud scans your cloud environment and reports what's wasting money. Run it once for a quick audit, schedule it, or wire it into CI/CD to fail builds on policy violations.

- **20 high-signal detection rules:** orphaned volumes, idle databases, empty load balancers, and more
Expand All @@ -27,7 +29,8 @@ Like `tfsec` for Terraform or `trivy` for containers — CleanCloud scans your c
- Scheduled hygiene scans — cron job or weekly CI run to catch drift
- CI/CD enforcement gates — fail builds when waste exceeds your threshold

```
```console
$ cleancloud scan --provider aws --all-regions
Found 6 hygiene issues:

1. [AWS] Unattached EBS Volume — $40/month
Expand All @@ -53,20 +56,20 @@ Regions scanned: us-east-1, us-west-2, eu-west-1

## Get Started

```bash
pipx install cleancloud
pipx ensurepath # adds cleancloud to PATH — restart your shell after this
cleancloud demo # see sample findings without any cloud credentials
```console
$ pipx install cleancloud
$ pipx ensurepath # adds cleancloud to PATH — restart your shell after this
$ cleancloud demo # see sample findings without any cloud credentials
```

When you're ready to scan your real environment, authenticate first — then run:

```bash
```console
# AWS: make sure you're logged in (aws configure, aws sso login, or IAM role)
cleancloud scan --provider aws --all-regions
$ cleancloud scan --provider aws --all-regions

# Azure: make sure you're logged in (az login)
cleancloud scan --provider azure
$ cleancloud scan --provider azure
```

Not sure if your credentials have the right permissions? Run `cleancloud doctor --provider aws` or `cleancloud doctor --provider azure` first.
Expand All @@ -76,18 +79,18 @@ Not sure if your credentials have the right permissions? Run `cleancloud doctor
Got an AWS or Azure account? Run a real scan in seconds with no local setup.

**AWS — [AWS CloudShell](https://console.aws.amazon.com/cloudshell):**
```bash
pip install --upgrade cleancloud
cleancloud doctor --provider aws # check what permissions your session has
cleancloud scan --provider aws --all-regions
```console
$ pip install --upgrade cleancloud
$ cleancloud doctor --provider aws # check what permissions your session has
$ cleancloud scan --provider aws --all-regions
```

**Azure — [Azure Cloud Shell](https://shell.azure.com):**
```bash
pip install --upgrade --user cleancloud
export PATH="$HOME/.local/bin:$PATH"
cleancloud doctor --provider azure # check what permissions your session has
cleancloud scan --provider azure
```console
$ pip install --upgrade --user cleancloud
$ export PATH="$HOME/.local/bin:$PATH"
$ cleancloud doctor --provider azure # check what permissions your session has
$ cleancloud scan --provider azure
```

Both shells authenticate using your portal session — no separate credentials needed.
Expand Down Expand Up @@ -124,7 +127,8 @@ pip uninstall cleancloud && pipx install cleancloud && pipx ensurepath

## What It Looks Like

```
```console
$ cleancloud scan --provider aws --all-regions
Found 6 hygiene issues:

1. [AWS] Unattached EBS Volume
Expand Down Expand Up @@ -172,8 +176,8 @@ No cloud account yet? `cleancloud demo` shows sample output without any credenti

### Shareable markdown report

```bash
cleancloud scan --provider aws --all-regions --output markdown
```console
$ cleancloud scan --provider aws --all-regions --output markdown
```

Prints a grouped summary you can paste directly into a GitHub PR comment, Slack message, or issue:
Expand Down
Binary file added demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading