Files
OZM-Keks-Handbuch-v1/QUICKSTART.md

50 lines
1.5 KiB
Markdown

# 🦉 Crumbpages Doktor - Schnellstart
> *"Der Arztkoffer für den Crumbforest."*
Der **Crumbpages Doktor** (`crumbpages-doktor.sh`) ist dein Schweizer Taschenmesser für System-Diagnose, Git-Management und API-Tests.
## 🚀 Installation & Start
1. **Ausführbar machen:**
```bash
chmod +x crumbpages-doktor.sh
```
2. **Starten:**
```bash
./crumbpages-doktor.sh
```
*Beim ersten Start wird automatisch eine `.env` Datei erstellt (Template).*
3. **Setup (`.env` anpassen):**
Öffne die `.env` Datei und trage ggf. dein API-Token ein:
```bash
CRUMB_API_URL="http://localhost:8000"
CRUMB_API_TOKEN="dein-token-hier-oder-leer-lassen"
```
## 🛠️ Module im Überblick
| Modul | Beschreibung |
| :--- | :--- |
| **🌲 Git Workstation** | Interaktive Shell für Git. Mit Status-Anzeige (`gst`, `gd`...). |
| **🌐 DNS Doktor** | Prüft DNS Records (A, MX, SPF) für eine Domain. Erstellt Reports. |
| **🖥️ System Doktor** | Zeigt Host-Vitalwerte (Disk, RAM, OS, Kernel). |
| **🕸️ Web Tools** | API Tests mit `curl` Wrappern (`api_search`, `api_ask`, `api_get`). |
| **🔐 Remote Tools** | SSH Helper und SCP Uploads (`crumbupload`). |
| **🛠️ Werkzeugkasten** | Prüft installierte Tools (`htop`, `tree`, etc.) und bietet Shell-Aliase. |
## 💡 Top Befehle (One-Liner)
In der **Web Tools** Shell (Option 4):
* **RAG durchsuchen (JSON):**
```bash
api_search "docker"
```
* **Browser öffnen:**
```bash
open_url http://localhost:8000/docs
```