cadjou
87abd0c970
Détail : - Test-CadMasterUpdate lit désormais $CADMASTER_VERSION directement dans le cadMasterCLI.ps1 distant (regex) au lieu d'un fichier version.txt séparé - Suppression de version.txt (plus utilisé) et de sa mention dans README.md
208 lines
8.8 KiB
Markdown
208 lines
8.8 KiB
Markdown
# cadMasterCLI
|
|
|
|
Outil de lancement simplifié de scripts PowerShell pour les automates Distech Controls Eclypse.
|
|
|
|
---
|
|
|
|
> **IMPORTANT : Ce projet est un développement personnel indépendant.**
|
|
>
|
|
> Ce projet a été développé par Charles-Arthur DAVID à titre personnel.
|
|
> Distech Controls n'est pas responsable de ce projet et ne le supporte pas.
|
|
> Aucune demande de support ne sera prise en charge par Distech Controls.
|
|
> Distech Controls ne fournit aucune garantie ni assistance technique pour ce projet.
|
|
|
|
---
|
|
|
|
## À quoi ça sert ?
|
|
|
|
cadMasterCLI est une interface graphique qui vous permet de **lancer des scripts d'automatisation** sans savoir utiliser le terminal, sans connaître PowerShell, et sans configuration technique.
|
|
|
|
Il suffit de :
|
|
1. Faire un clique-droit sur le fichier cadMasterCLI.ps1 et choisir "Exécuter avec Powershell"
|
|
2. Sélectionner le script que vous souhaitez exécuter dans la liste à gauche
|
|
3. Remplir les informations demandées (adresse IP, fichier CSV, etc.)
|
|
4. Cliquer sur **Lancer le script** et suivre le résultat dans le journal d'exécution intégré
|
|
|
|
Les scripts sont téléchargés automatiquement depuis un serveur centralisé (Gitea). Si vous n'avez pas accès au réseau, les scripts déjà utilisés restent disponibles en mode hors ligne.
|
|
|
|
L'interface est disponible en **français et en anglais**, et cadMasterCLI **vérifie et propose ses propres mises à jour** au démarrage.
|
|
|
|
---
|
|
|
|
## Prérequis
|
|
|
|
| Élément | Détail |
|
|
|---|---|
|
|
| Système d'exploitation | Windows 10 ou Windows 11 |
|
|
| PowerShell | Version 5.1 — **déjà inclus dans Windows 10/11, rien à installer** |
|
|
| Accès réseau | Nécessaire pour télécharger les scripts (hors ligne possible si déjà téléchargés) |
|
|
|
|
Aucun autre logiciel n'est nécessaire.
|
|
|
|
---
|
|
|
|
## Installation
|
|
|
|
Aucune installation requise. cadMasterCLI est un seul fichier `.ps1`.
|
|
|
|
1. Téléchargez le fichier `cadMasterCLI.ps1` et placez-le dans un dossier de votre choix.
|
|
2. C'est tout.
|
|
|
|
---
|
|
|
|
## Premier lancement
|
|
|
|
### Étape 1 — Débloquer le fichier (première fois uniquement)
|
|
|
|
Windows peut bloquer les fichiers téléchargés depuis Internet. Pour lever ce blocage :
|
|
|
|
1. Faites un **clic droit** sur `cadMasterCLI.ps1`
|
|
2. Cliquez sur **Propriétés**
|
|
3. En bas de la fenêtre, cochez **Débloquer** si la case est présente
|
|
4. Cliquez sur **OK**
|
|
|
|
> Si la case "Débloquer" n'apparaît pas, l'étape n'est pas nécessaire.
|
|
|
|
### Étape 2 — Autoriser l'exécution des scripts (première fois uniquement)
|
|
|
|
Si un message d'erreur apparaît à propos de la "stratégie d'exécution" :
|
|
|
|
1. Appuyez sur la touche **Windows**, tapez `PowerShell`
|
|
2. Faites un clic droit sur **Windows PowerShell** → **Exécuter en tant qu'administrateur**
|
|
3. Copiez-collez la commande suivante et appuyez sur Entrée :
|
|
|
|
```
|
|
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
|
|
```
|
|
|
|
4. Tapez `O` pour confirmer, puis fermez la fenêtre PowerShell.
|
|
|
|
### Étape 3 — Lancer cadMasterCLI
|
|
|
|
**Méthode simple :** faites un **clic droit** sur `cadMasterCLI.ps1` → **Exécuter avec PowerShell**.
|
|
|
|
**Méthode alternative :**
|
|
1. Ouvrez PowerShell (touche Windows → tapez `PowerShell` → Entrée)
|
|
2. Naviguez vers le dossier contenant le fichier, par exemple :
|
|
```
|
|
cd C:\Outils\cadMasterCLI
|
|
```
|
|
3. Lancez le script :
|
|
```
|
|
.\cadMasterCLI.ps1
|
|
```
|
|
|
|
---
|
|
|
|
## Utilisation
|
|
|
|
cadMasterCLI tient dans **une seule fenêtre** : la liste des scripts à gauche, et un panneau à droite qui affiche la documentation, le formulaire et le journal d'exécution du script sélectionné.
|
|
|
|
### 1. Choisir la langue de l'interface
|
|
|
|
Un bouton **FR / EN** en haut à droite de la fenêtre permet de basculer l'interface entre français et anglais à tout moment. Au premier lancement, la langue de Windows est détectée automatiquement ; votre choix est ensuite mémorisé pour les prochaines fois.
|
|
|
|
### 2. Sélectionner un script
|
|
|
|
La liste à gauche affiche en permanence tous les scripts disponibles, avec pour chacun :
|
|
|
|
| Élément | Signification |
|
|
|---|---|
|
|
| Nom | Nom du script |
|
|
| Date | Date de la dernière mise à jour sur le serveur |
|
|
| Badge vert **En cache** | Le script a déjà été téléchargé sur cet ordinateur |
|
|
| Badge orange **Nouveau** | Une mise à jour est disponible pour ce script |
|
|
|
|
Cliquez sur un script pour afficher sa documentation et son formulaire de paramètres dans le panneau de droite.
|
|
|
|
### 3. Remplir les paramètres
|
|
|
|
Le panneau de droite affiche :
|
|
|
|
- **À gauche** : la documentation du script (README), pour comprendre à quoi il sert et comment le remplir.
|
|
- **À droite** : le formulaire de paramètres à remplir, ainsi que le journal d'exécution en dessous.
|
|
|
|
**Types de champs :**
|
|
|
|
| Apparence | Ce qu'il faut faire |
|
|
|---|---|
|
|
| Champ texte blanc | Saisir une valeur (adresse IP, nom d'utilisateur, etc.) |
|
|
| Boutons ronds (RadioButtons) | Sélectionner une option parmi les choix proposés |
|
|
| Case à cocher | Activer ou désactiver une option |
|
|
| Bouton **Parcourir...** | Choisir un fichier CSV sur votre ordinateur |
|
|
|
|
Les champs marqués **Obligatoire** doivent impérativement être remplis avant de pouvoir lancer le script. Le bouton **Lancer le script** reste grisé tant que ces champs sont vides — il devient vert une fois tout renseigné.
|
|
|
|
Cliquez sur **[?] Voir l'aide** sous un champ pour afficher une description détaillée de ce paramètre.
|
|
|
|
**Panneau README :**
|
|
- Cliquez sur **Fermer README** pour masquer la documentation et agrandir le formulaire.
|
|
- Cliquez sur **Ouvrir README** pour la réafficher.
|
|
- Vous pouvez redimensionner le panneau README en faisant glisser la barre de séparation entre les deux zones.
|
|
- Si le README du script propose une version française et anglaise, la section affichée suit automatiquement la langue choisie dans l'interface.
|
|
|
|
### 4. Lancer le script et suivre l'exécution
|
|
|
|
Une fois tous les champs obligatoires remplis :
|
|
|
|
- Cliquez sur **Lancer le script** (bouton vert).
|
|
- Le script s'exécute en arrière-plan ; sa sortie s'affiche **en direct dans le journal d'exécution**, directement dans la fenêtre (plus de fenêtre de terminal séparée).
|
|
- Pendant l'exécution, la liste des scripts et les boutons sont désactivés ; ils redeviennent disponibles à la fin.
|
|
- Un message final indique si l'exécution s'est terminée avec succès ou en erreur.
|
|
|
|
Cliquez sur **Retour à la liste** pour revenir à la liste des scripts et en sélectionner un autre.
|
|
|
|
---
|
|
|
|
## Mise à jour automatique des scripts
|
|
|
|
Lorsqu'une nouvelle version d'un script est disponible sur le serveur, cadMasterCLI le signale avec un badge **Nouveau** dans la liste et vous propose de télécharger la mise à jour au moment où vous sélectionnez ce script.
|
|
|
|
Les scripts sont stockés localement dans le sous-dossier `scripts\` à côté de `cadMasterCLI.ps1`.
|
|
|
|
---
|
|
|
|
## Mise à jour automatique de cadMasterCLI lui-même
|
|
|
|
À chaque démarrage, cadMasterCLI vérifie s'il existe une version plus récente de lui-même sur le serveur.
|
|
|
|
- Si c'est le cas, une fenêtre vous propose de l'installer.
|
|
- En acceptant, la nouvelle version est téléchargée, remplace automatiquement le fichier `cadMasterCLI.ps1` actuel, et l'application redémarre toute seule.
|
|
- En refusant, l'application continue de démarrer normalement avec la version actuelle (la question sera reposée au prochain lancement).
|
|
- Si le serveur est inaccessible, aucune vérification n'est possible : cadMasterCLI démarre normalement, sans message d'erreur.
|
|
|
|
---
|
|
|
|
## Mode hors ligne
|
|
|
|
Si le serveur Gitea est inaccessible (pas de réseau), cadMasterCLI utilise automatiquement les scripts déjà téléchargés. Un message vous prévient que vous êtes en mode hors ligne.
|
|
|
|
---
|
|
|
|
## Cas d'erreurs fréquents
|
|
|
|
| Message | Cause probable | Solution |
|
|
|---|---|---|
|
|
| Erreur de stratégie d'exécution | PowerShell bloque les scripts | Voir **Étape 2** du premier lancement |
|
|
| Impossible de contacter Gitea | Pas d'accès réseau | Vérifiez votre connexion ou utilisez le mode hors ligne |
|
|
| Script introuvable en cache | Script jamais téléchargé + pas de réseau | Connectez-vous au réseau et relancez |
|
|
| Fichier bloqué par Windows | Script téléchargé depuis Internet | Voir **Étape 1** du premier lancement |
|
|
|
|
---
|
|
|
|
## Structure des fichiers
|
|
|
|
```
|
|
cadMasterCLI/
|
|
├── cadMasterCLI.ps1 ← fichier principal à lancer
|
|
├── cadmastercli.config.json ← préférence de langue (créé automatiquement)
|
|
├── README.md ← cette documentation
|
|
├── doc_contribution/
|
|
│ ├── CONTRIBUTING_SCRIPTS.md ← guide pour créer de nouveaux scripts
|
|
│ ├── _template_script.ps1 ← modèle de script
|
|
│ └── _template_script.README.md ← modèle de README bilingue FR/EN
|
|
└── scripts/ ← scripts téléchargés (créé automatiquement)
|
|
└── NomDuScript/
|
|
└── NomDuScript.ps1
|
|
```
|