atlasia-ghost 0.2.0 → 0.3.2

package/README.md

@@ -1,69 +1,132 @@
-# 👻 Ghost CLI
+# 👻 Ghost CLI [![ghost audit passed](https://img.shields.io/badge/ghost%20audit-passed-success)](https://github.com/atlasia/ghost)
 
-Assistant Git Intelligent (Node.js Edition) - Zéro-dépendance, compatible Windows, Mac et Linux.
-
-Ghost analyse vos changements Git (`staged`), vérifie l'absence de secrets (clés API, tokens) et propose un message de commit professionnel suivant la convention **Conventional Commits**.
+> Assistant Git Intelligent, Local & Sécurisé.
 
 ## 🚀 Installation
 
-Vous pouvez installer Ghost globalement via npm :
-
 ```bash
 npm install -g atlasia-ghost
 ```
 
-Ou l'utiliser directement avec npx :
-
-```bash
-npx atlasia-ghost
-```
+## 🧩 Version Management (Before Commits/Tags)
 
-## ⚙️ Configuration
+Ghost can manage semantic versions (SemVer) and enforce version bump rules through Git hooks.
 
-Au premier lancement, Ghost vous demandera une **clé API Groq** (gratuite).
-Vous pouvez en obtenir une ici : [https://console.groq.com](https://console.groq.com)
+### Quick start
 
-La configuration est stockée dans `~/.ghost`.
+1) Create a shared version config in your repo:
+```bash
+ghost version init
+```
 
-## 🛠️ Utilisation
+2) Install hooks in the current Git repository:
+```bash
+ghost version install-hooks
+```
 
-Préparez vos fichiers comme d'habitude :
+3) Bump version (manual) and create an annotated tag:
+```bash
+ghost version bump --bump minor --tag
+```
 
+4) Automatic bump based on Conventional Commits since last tag:
 ```bash
-git add .
-ghost
+ghost version bump --from-commits --tag
 ```
 
-### Options disponibles
+### What the hooks do
 
-| Option | Description |
-| :--- | :--- |
-| `--model <name>` | Utiliser un modèle spécifique (ex: `llama-3.1-8b-instant`) |
-| `--provider <name>` | Choisir le fournisseur (`groq` [défaut], `openai`) |
-| `--no-security` | Désactiver l'audit de sécurité (scan de secrets) |
-| `--dry-run` | Générer le message sans effectuer le commit |
-| `--help`, `-h` | Afficher l'aide |
+- `pre-commit`: blocks commits when merge conflicts are present.
+- `commit-msg`: reads the commit message, determines required bump (major/minor/patch) from Conventional Commits, and blocks the commit if the version file in the Git index is not bumped enough.
 
-## 📝 Personnalisation
+### CI / builder-friendly output
 
-### Sélection de fichiers
-Ghost propose désormais une sélection interactive si plusieurs fichiers sont modifiés. Vous pouvez spécifier les fichiers à analyser (ex: `1,3,5`) ou tout analyser (`all`).
+- Non-interactive mode:
+```bash
+ghost version bump --from-commits --tag --ci
+```
+- JSON output (for CI logs parsing):
+```bash
+ghost version bump --from-commits --tag --output json
+```
 
-### Configuration locale (`.ghostrc`)
-Vous pouvez personnaliser le comportement de Ghost par projet en créant un fichier `.ghostrc` à la racine :
+### Shared configuration (.ghost-versionrc)
 
+Commit `.ghost-versionrc` to your repository so both coders and builders use the same rules.
+
+Minimal example:
 ```json
 {
-  "prompt": "Ton prompt système personnalisé pour l'IA ici",
-  "provider": "openai"
+  "versionFiles": [{ "type": "package-json", "path": "package.json" }],
+  "tagPrefix": "v",
+  "requireVersionBump": true,
+  "autoTagAfterBump": true,
+  "notifications": { "webhookUrl": null }
 }
 ```
 
-## 🛡️ Sécurité
+## 🧯 Merge Conflict Detection & Assistance
+
+Ghost can detect and help you resolve merge conflicts.
+
+```bash
+ghost merge status
+ghost merge resolve
+```
+
+Non-interactive resolution (all conflicted files):
+```bash
+ghost merge resolve --strategy ours --ci
+ghost merge resolve --strategy theirs --ci
+```
+
+## 🤝 Collaborative Workflow (Coders + Builders)
 
-Ghost effectue un double audit :
-1. **Local** : Scan par expressions régulières (Regex) et analyse d'entropie de Shannon pour détecter des patterns suspects.
-2. **IA** : En cas de doute, les fragments suspects sont analysés par l'IA pour confirmer s'il s'agit d'une faille réelle ou d'un faux positif.
+- Shared rules: commit `.ghostrc` and `.ghost-versionrc` to the repo.
+- Branch protection (recommended): protect `main`/`master`, require PR reviews, and run CI checks that execute `npm test`.
+- Automated notifications: configure `notifications.webhookUrl` in `.ghost-versionrc` to POST structured events after version bump/tag operations.
+
+## 🛡️ Gestion des Secrets
+
+Ghost intègre un scanner de sécurité avancé pour empêcher les commits de secrets (clés API, tokens, etc.).
+
+### Lancer un audit manuel
+Vous pouvez auditer l'ensemble de votre projet à tout moment :
+```bash
+ghost audit --verbose
+```
+
+### Ignorer des faux positifs (.ghostignore)
+Si Ghost détecte un faux positif (ex: une longue chaîne de configuration non sensible), vous pouvez l'ajouter dans un fichier `.ghostignore` à la racine de votre projet.
+
+Exemple de `.ghostignore` :
+```text
+# Ignorer une clé publique de test
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQE
+
+# Ignorer un fichier entier
+config/test_keys.js
+```
+
+## 📊 Console de Monitoring & MCP (Nouveau v0.3.2)
+
+Ghost intègre désormais une console de débogage et de monitoring temps réel, inspirée de Gemini.
+
+```bash
+ghost console
+# ou
+ghost --console
+```
+Cela lance un serveur local sur `http://localhost:3000` affichant :
+- 📈 Métriques en temps réel (Latence API, nombre de requêtes, erreurs)
+- 📝 Logs structurés et alertes de sécurité
+- 🔌 **Endpoint MCP** : Compatible avec le *Model Context Protocol* sur `/mcp` pour l'intégration avec les IDEs et agents IA.
+
+### Important : `desktop/` et `npm run desktop:dev`
+- `ghost console` / `ghost --console` fonctionne **après installation globale** (`npm install -g atlasia-ghost`) : c'est une console **web locale** (serveur HTTP) incluse dans le package NPM.
+- `npm run desktop:dev` est **uniquement** une commande de **développement** de l'application Electron/React située dans `desktop/`.
+  - Elle nécessite un **clone du repository** (`git clone`), puis `npm install` dans `desktop/`.
+  - Cette application **n'est pas** installée via `npm install -g atlasia-ghost` (le package NPM ne publie que le CLI `ghost.js`).
 
 ## 📄 Licence