docs: README minimiert, docs/-Ordner mit Schnellstart, Installation, Verwendung, Beispielen, Fehlerbehandlung und technischen Details angelegt

This commit is contained in:
2026-04-10 12:25:27 +02:00
parent f03673ec75
commit 393cbc4926
7 changed files with 185 additions and 188 deletions

50
docs/usage.md Normal file
View File

@@ -0,0 +1,50 @@
# Verwendung
Das Script kann auf zwei Arten verwendet werden.
## Interaktiver Modus (Menü)
```bash
bash ./dockernet-inspector.v1.sh
```
Das Script startet ein interaktives Menü mit folgenden Optionen:
- **1** Alle Netzwerke auflisten
- **2** Detaillierte Infos zu einem Netzwerk (mit Netzwerk-Auswahl)
- **3** IPs eines Netzwerks anzeigen (mit Netzwerk-Auswahl)
- **4** Alle belegten IPs anzeigen
- **0** Beenden
Bei den Optionen **2** und **3** wird eine Netzwerkliste angezeigt, aus der per Nummer ausgewählt werden kann.
## Kommandozeilen-Modus (CLI)
```bash
bash ./dockernet-inspector.v1.sh [BEFEHL] [OPTIONEN]
```
### Verfügbare Befehle
| Befehl | Beschreibung |
|--------|--------------|
| *(keine)* | Startet den interaktiven Modus |
| `networks` | Listet alle verfügbaren Docker-Netzwerke auf |
| `inspect <netzwerk>` | Zeigt detaillierte Informationen zu einem Netzwerk |
| `ips <netzwerk>` | Zeigt alle belegten IPv4-Adressen im angegebenen Netzwerk |
| `ips-all` | Zeigt alle belegten IPv4-Adressen in allen Docker-Netzwerken (aufsteigend sortiert) |
| `<netzwerk>` | Alias für `inspect <netzwerk>` (Rückwärtskompatibilität) |
| `help`, `-h`, `--help` | Zeigt die Hilfe an |
### Kurzbeispiele
```bash
bash ./dockernet-inspector.v1.sh networks
bash ./dockernet-inspector.v1.sh inspect bridge
bash ./dockernet-inspector.v1.sh my-custom-network
bash ./dockernet-inspector.v1.sh ips dockernet
bash ./dockernet-inspector.v1.sh ips-all
bash ./dockernet-inspector.v1.sh help
```
Ausführliche Ausgabe-Beispiele sind in [examples.md](examples.md) zu finden.