@masjidun/cli 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,69 @@
-# Temporary Holding Version
+# Masjidun-Kommandozeile
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Die Kommandozeile `masjidun` für die Masjidun-Verwaltung: dieselben Daten und dieselben Rechte wie in der App, nur im Terminal, für Skripte und für KI-Agenten wie Claude Code.
+
+## Einrichten
+
+Einmal je Rechner, auf Windows und macOS gleich.
+
+1. **Node.js installieren:** auf [nodejs.org](https://nodejs.org/de/download) die Version 24 (LTS) laden und den Installer durchklicken, unter Windows die `.msi`, auf dem Mac die `.pkg`.
+   Wer Node.js 24 oder neuer schon hat, überspringt das; `node --version` zeigt die Version.
+2. **Terminal öffnen:** unter Windows „Terminal“ oder „PowerShell“ aus dem Startmenü, auf dem Mac „Terminal“ (Spotlight: Cmd+Leertaste, „Terminal“).
+3. **Kommandozeile installieren:**
+
+   ```sh
+   npm install -g @masjidun/cli
+   ```
+
+4. **Anmelden:**
+
+   ```sh
+   masjidun anmelden
+   ```
+
+   Der Browser öffnet eine Freigabe-Seite von Masjidun mit vorausgefülltem Code.
+   Dort mit dem eigenen Masjidun-Konto anmelden und auf „Anmelden“ klicken, danach ist das Terminal angemeldet.
+   Die Sitzung liegt im Schlüsselbund des Systems (Windows-Anmeldeinformationsverwaltung, macOS-Schlüsselbund) und gilt sieben Tage ab der letzten Nutzung.
+
+`masjidun wer` zeigt, als wer und für welche Moschee du angemeldet bist; `masjidun hilfe` zeigt alle Befehle.
+
+## Wenn es hakt
+
+- **Windows: „Die Datei … npm.ps1 kann nicht geladen werden, da die Ausführung von Skripts auf diesem System deaktiviert ist“** (oder dasselbe mit `masjidun.ps1`): PowerShell erlaubt Skripte erst nach einer Freigabe.
+  Einmal in PowerShell ausführen, danach den Befehl wiederholen:
+
+  ```powershell
+  Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
+  ```
+
+  Ohne Freigabe geht es auch in der „Eingabeaufforderung“ (`cmd`), dort heißen die Befehle genauso.
+- **macOS: `EACCES` oder „permission denied“ beim Installieren:** Der `.pkg`-Installer von Node.js legt den Ordner für global installierte Pakete dem Systemkonto an.
+  Dann mit vorangestelltem `sudo` installieren und das Mac-Passwort eingeben, beim Aktualisieren genauso:
+
+  ```sh
+  sudo npm install -g @masjidun/cli
+  ```
+
+  Ohne `sudo` geht es, wenn Node.js statt mit dem Installer über die auf nodejs.org angebotene Variante „nvm“ eingerichtet ist.
+
+- **„Befehl nicht gefunden“ direkt nach dem Installieren:** Terminal schließen und neu öffnen, damit es den neuen Befehl kennt.
+- **„Diese Kommandozeile ist zu alt“:** aktualisieren, siehe unten.
+
+## Aktualisieren und entfernen
+
+Gibt es eine neue Version, sagt die Kommandozeile es höchstens einmal am Tag von selbst.
+
+```sh
+npm install -g @masjidun/cli
+```
+
+Entfernen: erst `masjidun abmelden`, dann `npm uninstall -g @masjidun/cli`.
+
+## Mit Claude Code
+
+```sh
+masjidun mcp einrichten
+```
+
+meldet eine eigene Sitzung für den Agenten an und trägt den MCP-Server bei Claude Code ein.
+Der Agent arbeitet danach mit deinen Rechten, nicht mit mehr.