## Benutzerhandbuch

---

### Erste Schritte

---

Nach der [Installation](/doc/sdk/cli-ng/de/guides/installation) und [Konfiguration](/doc/sdk/cli-ng/de/guides/configuration) eines Profils überprüfen Sie, ob Ihre Verbindung funktioniert:

```bash
rbw whoami
```

Dieser Befehl zeigt die Informationen des verbundenen Rainbow-Kontos an (Name, E-Mail, Rollen).

### Globale Optionen

---

Diese Optionen gelten für alle Befehle:

| Option | Beschreibung |
|---|---|
| `--profile <name>` | Verwendet das angegebene Profil für diesen Befehl |
| `--debug` | Aktiviert detaillierte Debug-Protokolle |
| `--verbose` | Aktiviert ausführliche Ausgabe |
| `--log <file>` | Schreibt Protokolle in eine Datei |

Beispiele:

```bash
rbw --profile sandbox --debug users
rbw --log debug.log companies
```

### Hauptbefehle

---

#### Benutzer

```bash
rbw users                                     # Benutzer auflisten
rbw user find <query>                         # Nach Name oder E-Mail suchen
rbw user get <id>                             # Benutzerdetails
rbw user create <email> <pwd> <vor> <nach>    # Benutzer erstellen
rbw user update <id>                          # Benutzer aktualisieren
rbw user delete <id>                          # Benutzer löschen
```

#### Unternehmen

```bash
rbw companies                                 # Unternehmen auflisten
rbw company find <query>                      # Nach Name suchen
rbw company get <id>                          # Unternehmensdetails
rbw company create <name>                     # Unternehmen erstellen
```

#### Anwendungen

```bash
rbw applications                              # Anwendungen auflisten
rbw application create <name>                 # Anwendung erstellen
rbw application block <id>                    # Anwendung sperren
rbw application delete <id>                   # Anwendung löschen
rbw application-deploy [id]                   # Bereitstellen (interaktiver Workflow)
```

#### API-Schlüssel

```bash
rbw apikeys                                   # API-Schlüssel auflisten
rbw apikey create <description>               # API-Schlüssel erstellen
rbw apikey delete <id>                        # API-Schlüssel löschen
```

#### Metriken

```bash
rbw metrics applications                      # Anwendungsnutzungsmetriken
rbw metrics application <id>                  # Metriken einer bestimmten Anwendung
```

### Interaktiver Modus

---

Listenbefehle unterstützen einen interaktiven Modus zum Erkunden von Ressourcen in einem navigierbaren Baum:

```bash
rbw users --interactive
rbw applications --interactive
rbw companies --interactive
```

**Navigation**:

| Taste | Aktion |
|---|---|
| `↑` / `↓` | In der Liste navigieren |
| `Enter` | Auswählen / Erweitern |
| `q` | Interaktiven Modus beenden |

### Datenexport

---

Einige Befehle unterstützen Export und JSON-Ausgabe:

```bash
rbw applications -f apps.csv                  # CSV-Export
rbw applications --json                       # JSON-Rohausgabe
rbw companies --json                          # JSON-Rohausgabe
```

### Filter

---

Listenbefehle akzeptieren Filter zur Eingrenzung der Ergebnisse:

```bash
rbw users --company <name>                    # Nach Unternehmen filtern
rbw users --role <role>                       # Nach Rolle filtern
rbw users --email <email>                     # Nach E-Mail filtern
rbw applications --deployed                   # Nur bereitgestellte Anwendungen
rbw applications --blocked                    # Nur gesperrte Anwendungen
```

### Kontexthilfe

---

Jeder Befehl verfügt über eine integrierte Hilfe:

```bash
rbw --help                                    # Allgemeine Hilfe
rbw user --help                               # Hilfe für eine Befehlsgruppe
rbw user get --help                           # Hilfe für einen bestimmten Befehl
```

### Integrierte REST-API-Dokumentation

---

Das CLI enthält einen Browser für die Rainbow REST-API-Dokumentation:

```bash
rbw api-docs browse
rbw api-docs search <Stichwörter>
```

Ein interaktiver TUI-Modus ermöglicht es, Endpunkte zu durchsuchen, ihre Parameter anzuzeigen und sie direkt vom Terminal aus zu testen.

### Integrierte Leitfäden

---

Rainbow-Entwicklerleitfäden sind über das CLI zugänglich:

```bash
rbw guides browse
rbw guides search <Stichwörter>
rbw guides show <Leitfaden>
```
